Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JOSS paper for the package #90

Open
wang-boyu opened this issue Aug 29, 2024 · 6 comments
Open

JOSS paper for the package #90

wang-boyu opened this issue Aug 29, 2024 · 6 comments

Comments

@wang-boyu
Copy link
Member

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
Copy link
Collaborator

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
Copy link
Member Author

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) -

  • list of authors
  • summary
  • statement of need
  • acknowledgement of financial support (gsoc)
  • references

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
Copy link
Collaborator

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

@wang-boyu
Copy link
Member Author

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
Copy link
Member

EwoutH commented Sep 13, 2024

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.

@jackiekazil
Copy link
Member

+1 @EwoutH's comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants