projectmesa / mesa-frames

Extension of mesa for performance and scalability
https://projectmesa.github.io/mesa-frames
Apache License 2.0
13 stars 4 forks source link

JOSS paper for the package #90

Open wang-boyu opened 2 weeks ago

wang-boyu commented 2 weeks ago

We discussed in one of the update meetings that there'll be a JOSS paper for mesa-frames.

Do you mind creating a dedicated branch for it (e.g., joss or paper or any other branch name you prefer)? We can start creating PRs to that branch. It can then be merged into main when ready.

adamamer20 commented 2 weeks ago

We discussed in one of the update meetings that there'll be a JOSS paper for mesa-frames.

Do you mind creating a dedicated branch for it (e.g., joss or paper or any other branch name you prefer)? We can start creating PRs to that branch. It can then be merged into main when ready.

That's wonderful! I'll do that.

wang-boyu commented 1 week ago

With #104 merged, @adamamer20 would you like to start drafting the paper?

The sections that the paper should have are (per https://joss.readthedocs.io/en/latest/paper.html) -

And we can have more sections for things like component structures, designs, etc (but not API documentations). The sections listed above are minimum requirements.

Once the paper is ready, we can submit it to JOSS, which has another checklist for reviewers: https://joss.readthedocs.io/en/latest/review_checklist.html. We can then work with the reviewers to get it published.

adamamer20 commented 1 week ago

Perfect, I will start making the PRs. Who should I list as author, other than me?

wang-boyu commented 5 days ago

Thanks @adamamer20. We can start working on other sections while figuring out the authorship.

Who should I list as author, other than me?

@projectmesa/maintainers any suggestions?

EwoutH commented 5 days ago

I think that’s up to you really, Adam. I think you can list yourself als sole author, or can choose to add mentors/reviewers as co-authors.