APSIMInitiative / ReferencePanel

2 stars 2 forks source link

Guidelines for naming models that function in APSIM vs APSIM models #80

Open sarahcleary opened 3 years ago

sarahcleary commented 3 years ago

Outstanding Action from AI SC Meeting: Provide guidelines for users with regard to badging (and referencing) their models as APSIM prior to AI RP peer review.

ACTION: @Keith-Pembleton to draft guidelines for review. Include examples of best practice

Keith-Pembleton commented 3 years ago

How about the text below? It could go on the how do I cite cite APSIM page on the website. If anybody has better examples for the first point we can swap them in. Also can someone please propose an example for the second point. There was an exampled mentioned in the last RP meeting but I did not write it down.

_When referring to APSIM in the methods section of a publication, it is important to provide enough detail so that the research could be repeated. Consequently, in addition to providing the appropriate APSIM citation authors should provide the version/build number of APSIM or APSIM next generation that was used along with any modifications to parameters and source code that were made. For examples see the description of the addition of a forage brassica cultivar to the canola module (https://doi.org/10.1071/CP12372) or the addition of CO2 impacts on transpiration efficiency and critical nitrogen concentrations to a range of crops (https://doi.org/10.1017/S0021859615001185) in APSIM.

The APSIM initiative encourages the publication of work based on prototype modules or modules under development. Such publications in their methods sections should make it clear to the reader that the research reported is based on prototype/modules under development. Again it is important that enough details are provided so that the research could be repeated. Consequently it is likely that the prototype module and simulations used will need to be made available for readers and reviewers to access either as supplementary material or in a research repository. For an example see https://doi.org/XXXXXXXXXXXXXXXX. Authors are responsible for the appropriate archiving of the prototype modules used. The publication of a prototype module/module under development does not remove the obligation on APSIM users/developers under the APSIM research and development licence to provide all APSIM improvements to the APSIM Initiative for review and consideration for incorporation into the official APSIM release. Only modules/improvements that have been reviewed, accepted by the APSIM initiative and incorporated into the official APSIM release can be referred to as as being APSIM.__

sarahcleary commented 3 years ago

@APSIMInitiative/reference-panel - please review @Keith-Pembleton's proposed wording. Thanks Keith.

sno036 commented 3 years ago

Fine by me.

Keith-Pembleton commented 3 years ago

Thinking about it a bit more. @sarahcleary would the archiving of a prototype model in a repository also require the R&D licence to be placed with it?

peter-devoil commented 3 years ago

Good stuff, keith. Perhaps "...review and consideration for incorporation" should link to https://apsimnextgeneration.netlify.app/development/science/ for concrete actions

sarahcleary commented 3 years ago

@Keith-Pembleton - APSIM Classic is archived on the CSIRO Data Access Portal - and does state that this files can be only access by licensed APSIM users - https://data.csiro.au/collections/collection/CIcsiro:45020/SQAPSIM%20Classic/RP1/RS25/RORELEVANCE/STsearch-by-keyword/RI1/RT1/ @her123 drove this process.

jbrider commented 3 years ago

@sarahcleary @hol353 Talking about links to the license agreement - the readme that is visible when viewing the APSIM Nextgen repository refers to the License Agreement and states that it can be reviewed on http://www.apsim.info/. I had to use google to actually find the license agreement on the web site. I think we should have a more specific link.

sarahcleary commented 3 years ago

Maybe we can update this link to https://www.apsim.info/download-apsim/
The reason we take users through this process is so they clearly see there are two options - non-commercial and commercial use. We could put two links - https://www.apsim.info/wp-content/uploads/2020/05/APSIM_NonCommercial_RD_licence.pdf and https://www.apsim.info/wp-content/uploads/2020/05/APSIM_Commercial_Licence.pdf

Keith-Pembleton commented 3 years ago

anyone have a best practice example for the second point?

sarahcleary commented 3 years ago

Webpage updated - https://www.apsim.info/download-apsim/ @jbrider - is that better?

@APSIMInitiative/reference-panel - any further input?

@Keith-Pembleton - next step?

sarahcleary commented 3 years ago

@APSIMInitiative/reference-panel - as @Keith-Pembleton has asked before - best practice example for the second point? If someone can provide this (a good citation for prototype modules or modules under development), then I can finalise and put on the website. @hut104 @JJguri

sarahcleary commented 3 years ago

@Keith-Pembleton - where is this at?