Improve the overview of ABSESpy docs #49
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation changes
#docs📄 Line 24: 'research' not 'researches'
#docs📄 Line 44: rather than 'et al.' maybe use actual words (e.g. 'and others') so as not to confuse against the file suffixes which are similar abbreviations
#docs📄 Line 55: What do you mean by 'practicing' here? This doesn't seem right. Please edit to clarify
#docs📄 Lines 57-65: I'm surprised these three points (Perceptions, Decision-making, Response) don't match the words used in Fig 2 (Options, Evaluate, Behaviour). Or are the latter three (in the Fig) all part of the 'decision-making' step? Aligning the steps in the list with the figure would be useful, I think
#docs📄 Line 76: I think 'vary' should be 'varying'
#docs📄 Line 93: 'more accurate' - this is a relative statement, so please clarify 'more accurate' than what?
#docs📄 Line 99: ( wang2022h? )) is not included in the reference list
#docs📄 Line 100: it's good that you recognise the similarity here to
AgentPy
but you don't then clearly explain howabsespy
is beneficial for SES researchers - maybe you could highlight the explicit functionality for representing the 'nature' side of CHANS (AgentPy
really focuses on the 'human' side).#docs📄 Line 108: 'merely heuristic' - I think this is a little over-critical of NetLogo, which can incorporate 'real-world' (I think you mean 'empirical'?) data although not at the scale
absespy
could. I suggest you edit here to focus on the value ofabsespy
for working with large-scale, empirical data so that models can run more efficiently than would be possible for the same data in NetLogo. You might also highlight yourTimeDriver
module which is a benefit over NetLogo's more simple 'ticks'#docs📄 L105 & L151: netlogo and Netlogo should be NetLogo
#docs📄 L42, L98, L101 & L153 : mesa-geo and Mesa-geo should be Mesa-Geo
#docs📄 L95, L97, L98, L102, L129 & L153 : mesa should be Mesa
#docs📄 L96: abce should be ABCE
#docs📄 L128, L148 & L154: python should be Python
#docs📄 Update project readme
#docs📄 Improve JOSS paper overall.