paper: Restructure to present Mesa as complete framework#2560
paper: Restructure to present Mesa as complete framework#2560EwoutH merged 2 commits intomesa:paper_2024from
Conversation
Rather than focusing on Mesa 3.0 changes, rewrite paper to provide comprehensive overview of Mesa as a complete ABM framework. Key changes: - Reorganize core capabilities into three main sections: - ABM Framework (agents, spaces, time management) - Visualization - Experimentation and Analysis - Integrate experimental features naturally into relevant sections - Add more code examples demonstrating key capabilities - Update language to describe current state rather than changes - Expand technical detail while simplifying overall structure - Focus on Mesa 3.1.1 as current stable version - Add clearer descriptions of time management approaches - Enhance description of data analysis capabilities This updated structure better serves as a complete reference for Mesa's capabilities while maintaining technical depth and accessibility.
|
Before we merge this -- I think we need to have a consensus on changes in this direction -- not sure we have this yet, and it is silly for folks to do work to change things back and forth. |
|
@projectmesa/maintainers please everyone let know your preference to which kind of paper you want:
I'm indifferent, both have their merit. |
|
I am in favor of option 2 (as might have been clear from my review of #2533). |
|
I have been chewing on this the few days since the #2533 debate started. I suppose what I want to propose is hybrid.
Why:
|
|
Thanks for your feedback Tom.
Agreed, and this is currently already the case.
Personally I think it's nice to be explicit about it. Maybe just say 3.1.
Will do
Agreed. With this PR, that is currently the case right? As of LLMs, this will keep being a problem as long as they don't take in . Just advice anyone to upload getting_started.md and migration_guide.md whenever using an LLM. Optionally, also add agent.py and model.py. With that, it works perfectly in my experience. It looks like there's a small nudge towards options 2:
@projectmesa/maintainers I would like some explicit reviews on this PR: Either green checkmarks or concrete comments/suggestions. |
I haven't seen any papers in JOSSS with the version number in the title which is why I adviced to remove it from the title. I agree that we should mention very early that this paper reflects mesa 3 and then just move on and talk about MESA as such.
I don't think it will move the needle at all. what is needed is to have more mesa 3 examples, new LLMs trained on more recent code bases, and the work around @EwoutH suggested.
On it, hope to have a bunch of suggestions soon. Do you mind if I commit directly, or do you prefer me using github's suggestion feature? |
|
Summary and statement of need are fine with some minor possible language fixes (comma stuff). I like the restructuring. It reads a lot nicer now. I personally would expand the start on core ABM components a bit along the lines I suggested before. So, give a 1 paragraph description of what ABM modeling is and make sure we mention agents, agent activation, and environment. Next, we can introduce Agents, Agent activation via agentsets, and representing the environment (I prefer this phrasing over spatial modeling which might easily be misunderstood). I noticed that the grid stuff is still about the old style grids. Is this a deliberate choice? I am happy to make these changes if you want somewhere over the coming week. Likewise, I would flesh out the visualization and experimentation part a bit more. Again, I can take a stab at this if desired. For example, it would be good to add that the UI uses Solara with a reference to this library and a short 1 or 2 sentence elaboration that this means that users can build web based UIs that are either stand alone or can be used within a jupyter notebook. Likewise, I would elaborate briefly on the parameter sweeps by stating that this supports full factorial sampling, seed control, and (limited) support for parallelization. Next, in a few sentences we can elaborate that other python libraries can be used if more sophisticated sampling is required. What is the plan regarding adding citations? |
|
Thanks for your thoughts!
Great to hear!
References can go into paper/paper.bib. We can add them using (see JOSS manual):
I think most practical is I merge this PR, since we seem to agree this moves the paper in the right direction. Then you can propose your changes in a new PR to the |
Yes that workflow makes good sense to me. |
|
Merged, go ahead! |
Rather than focusing on Mesa 3.0 changes, rewrite paper to provide comprehensive overview of Mesa as a complete ABM framework. Key changes: - Reorganize core capabilities into three main sections: - ABM Framework (agents, spaces, time management) - Visualization - Experimentation and Analysis - Integrate experimental features naturally into relevant sections - Add more code examples demonstrating key capabilities - Update language to describe current state rather than changes - Expand technical detail while simplifying overall structure - Focus on Mesa 3.1.1 as current stable version - Add clearer descriptions of time management approaches - Enhance description of data analysis capabilities This updated structure better serves as a complete reference for Mesa's capabilities while maintaining technical depth and accessibility.
As discussed in #2533, this PR rewrites the paper to provide comprehensive overview of Mesa as a complete ABM framework, rather than focusing on Mesa 3.0 changes.
Key changes:
Rendered PDF download.
Part of #2559.