[REVIEW]: FAME-Io: Configuration tools for complex agent-based simulations

[editorialbot]

Submitting author: !--author-handle-->@dlr_fn<!--end-author-handle-- (Felix Nitsch) Repository: https://gitlab.com/fame-framework/fame-io Branch with paper.md (empty if default branch): 139-prepare-publication Version: v1.7 Editor: !--editor-->@fraukewiese<!--end-editor-- Reviewers: @imcatta, @robbiemorrison Archive: 10.5281/zenodo.4314337

Status

Status badge code:

HTML: <a href="https://joss.theoj.org/papers/0fb5afa491ac1d22d79236ebec57f0eb"><img src="https://joss.theoj.org/papers/0fb5afa491ac1d22d79236ebec57f0eb/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/0fb5afa491ac1d22d79236ebec57f0eb/status.svg)](https://joss.theoj.org/papers/0fb5afa491ac1d22d79236ebec57f0eb)

Reviewers and authors:

Please avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the target repository and link to those issues (especially acceptance-blockers) by leaving comments in the review thread below. (For completists: if the target issue tracker is also on GitHub, linking the review thread in the issue or vice versa will create corresponding breadcrumb trails in the link target.)

Reviewer instructions & questions

@imcatta & @robbiemorrison, your review will be checklist based. Each of you will have a separate checklist that you should update when carrying out your review. First of all you need to run this command in a separate comment to create the checklist:

@editorialbot generate my checklist

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @fraukewiese know.

✨ Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest ✨

Checklists

📝 Checklist for @imcatta

📝 Checklist for @robbiemorrison

[kyleniemeyer]

@fraukewiese @danielskatz @arfon as long as the DOIs are correct for what they will be, then I think that's fine. Though we may want to wait to publish all three together?

[fraukewiese]

Thanks @kyleniemeyer @danielskatz @openjournals/pe-eics for your answers. Yes, I think it is a good idea to publish all three together. I have put the recommend-accept in all three:

5041

4958

5087

Do I need to do anything else or do you take over at this point?

[fraukewiese]

@editorialbot recommend-accept

[editorialbot]

Attempting dry run of processing paper acceptance...

[editorialbot]

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1155/2017/7494313 is OK
- 10.1155/2017/1967645 is OK
- 10.1016/j.rser.2015.12.169 is OK
- 10.3390/en13153920 is OK
- 10.1016/j.energy.2016.03.038 is OK
- 10.1007/s10462-009-9105-x is OK
- 10.18564/jasss.4129 is OK
- 10.1016/j.rser.2014.02.003 is OK
- 10.1080/14693062.2020.1824891 is OK
- 10.3390/en13205350 is OK
- 10.1016/j.energy.2018.03.092 is OK
- 10.1016/j.erss.2018.10.021 is OK
- 10.1109/EEM49802.2020.9221924 is OK
- 10.5281/zenodo.5726738 is OK
- 10.1016/j.rser.2018.08.002 is OK
- 10.1177/0037549712462620 is OK

MISSING DOIs

- None

INVALID DOIs

- 10.21105/joss.05087 is INVALID
- 10.21105/joss.05041 is INVALID

[editorialbot]

The paper's PDF and metadata files generation produced some warnings that could prevent the final paper from being published. Please fix them before the end of the review process.

citation wilensky1999 not found

[editorialbot]

:warning: Error preparing paper acceptance. The generated XML metadata file is invalid.

IDREFS attribute rid references an unknown ID "ref-wilensky1999"

[fraukewiese]

@dlr_fn @fxnitsch Could you check the citation Wilensky 1999 in the paper?

[dlr-cjs]

@fraukewiese we are on it

[fxnitsch]

@dlr_fn @fxnitsch Could you check the citation Wilensky 1999 in the paper?

@fraukewiese: citation is fixed! Sorry for the inconvenience caused.

[kyleniemeyer]

@editorialbot recommend-accept

[editorialbot]

Attempting dry run of processing paper acceptance...

[editorialbot]

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1155/2017/7494313 is OK
- 10.1155/2017/1967645 is OK
- 10.1016/j.rser.2015.12.169 is OK
- 10.3390/en13153920 is OK
- 10.1016/j.energy.2016.03.038 is OK
- 10.1007/s10462-009-9105-x is OK
- 10.18564/jasss.4129 is OK
- 10.1016/j.rser.2014.02.003 is OK
- 10.1080/14693062.2020.1824891 is OK
- 10.3390/en13205350 is OK
- 10.1016/j.energy.2018.03.092 is OK
- 10.1016/j.erss.2018.10.021 is OK
- 10.1109/EEM49802.2020.9221924 is OK
- 10.5281/zenodo.5726738 is OK
- 10.1016/j.rser.2018.08.002 is OK
- 10.1177/0037549712462620 is OK

MISSING DOIs

- None

INVALID DOIs

- 10.21105/joss.05087 is INVALID
- 10.21105/joss.05041 is INVALID

[editorialbot]

:wave: @openjournals/pe-eics, this paper is ready to be accepted and published.

Check final proof :point_right::page_facing_up: Download article

If the paper PDF and the deposit XML files look good in https://github.com/openjournals/joss-papers/pull/4125, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

[kyleniemeyer]

Hello @dlr_fn @fxnitsch @dlr-cjs, I have made some small formatting fixes in https://gitlab.com/fame-framework/fame-io/-/merge_requests/120, could you merge that?

[fxnitsch]

Hi @kyleniemeyer, thank you for your edits which are already merged.

@fraukewiese We also checked the final proof. From our side, it is ready to be published!

[kyleniemeyer]

@editorialbot generate pdf

[editorialbot]

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

[kyleniemeyer]

@editorialbot accept

[editorialbot]

Doing it live! Attempting automated processing of paper acceptance...

[editorialbot]

Ensure proper citation by uploading a plain text CITATION.cff file to the default branch of your repository.

If using GitHub, a Cite this repository menu will appear in the About section, containing both APA and BibTeX formats. When exported to Zotero using a browser plugin, Zotero will automatically create an entry using the information contained in the .cff file.

You can copy the contents for your CITATION.cff file here:

CITATION.cff

``` cff-version: "1.2.0" authors: - family-names: Nitsch given-names: Felix orcid: "https://orcid.org/0000-0002-9824-3371" - family-names: Schimeczek given-names: Christoph orcid: "https://orcid.org/0000-0002-0791-9365" - family-names: Frey given-names: Ulrich orcid: "https://orcid.org/0000-0002-9803-1336" - family-names: Fuchs given-names: Benjamin orcid: "https://orcid.org/0000-0002-7820-851X" contact: - family-names: Nitsch given-names: Felix orcid: "https://orcid.org/0000-0002-9824-3371" doi: 10.5281/zenodo.4314337 message: If you use this software, please cite our article in the Journal of Open Source Software. preferred-citation: authors: - family-names: Nitsch given-names: Felix orcid: "https://orcid.org/0000-0002-9824-3371" - family-names: Schimeczek given-names: Christoph orcid: "https://orcid.org/0000-0002-0791-9365" - family-names: Frey given-names: Ulrich orcid: "https://orcid.org/0000-0002-9803-1336" - family-names: Fuchs given-names: Benjamin orcid: "https://orcid.org/0000-0002-7820-851X" date-published: 2023-04-17 doi: 10.21105/joss.04958 issn: 2475-9066 issue: 84 journal: Journal of Open Source Software publisher: name: Open Journals start: 4958 title: "FAME-Io: Configuration tools for complex agent-based simulations" type: article url: "https://joss.theoj.org/papers/10.21105/joss.04958" volume: 8 title: "FAME-Io: Configuration tools for complex agent-based simulations" ```

If the repository is not hosted on GitHub, a .cff file can still be uploaded to set your preferred citation. Users will be able to manually copy and paste the citation.

Find more information on .cff files here and here.

[editorialbot]

🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦

[editorialbot]

🐘🐘🐘 👉 Toot for this paper 👈 🐘🐘🐘

[editorialbot]

🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨

Here's what you must now do:

0. Check final PDF and Crossref metadata that was deposited :point_right: https://github.com/openjournals/joss-papers/pull/4132
1. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.04958
2. If everything looks good, then close this review issue.
3. Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? Notify your editorial technical team...

[kyleniemeyer]

Congratulations @dlr_fn @fxnitsch @dlr-cjs on your article's publication in JOSS—and the completion of this large three-package submission!

Many thanks to @imcatta and @robbiemorrison for reviewing this, and @fraukewiese for editing it (and the other two submissions).

[editorialbot]

:tada::tada::tada: Congratulations on your paper acceptance! :tada::tada::tada:

If you would like to include a link to your paper from your README use the following code snippets:

Markdown:
[![DOI](https://joss.theoj.org/papers/10.21105/joss.04958/status.svg)](https://doi.org/10.21105/joss.04958)

HTML:
<a style="border-width:0" href="https://doi.org/10.21105/joss.04958">
  <img src="https://joss.theoj.org/papers/10.21105/joss.04958/status.svg" alt="DOI badge" >
</a>

reStructuredText:
.. image:: https://joss.theoj.org/papers/10.21105/joss.04958/status.svg
   :target: https://doi.org/10.21105/joss.04958

This is how it will look in your documentation:

We need your help!

The Journal of Open Source Software is a community-run journal and relies upon volunteer effort. If you'd like to support us please consider doing either one (or both) of the the following:

• Volunteering to review for us sometime in the future. You can add your name to the reviewer list here: https://reviewers.joss.theoj.org/join
• Making a small donation to support our running costs here: https://numfocus.org/donate-to-joss