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

Paper: Fix Statement of Need; Acknowledgements, and Applications. #2695

Merged
merged 3 commits into from
Feb 19, 2025

Conversation

jackiekazil
Copy link
Member

@jackiekazil jackiekazil commented Feb 17, 2025

This ticket addresses the following in #2666 --

  • l16 The Statement of Need could be more clearly structured. Currently, it reads more like a historical recap. I recommend organizing it along these lines: (1) Why such a package is needed, (2) The current state of the field, and (3) What MESA contributes — focusing on its present state rather than its 2014 origins. Additionally, please refer to the Statement of Need and State of the Field requirements outlined in the JOSS checklist above to ensure alignment with the journal's expectations. (@jackiekazil)
  • l109 I would suggest to move the "Applications" section to the start of the paper (@jackiekazil)
  • l134 Acknowledgements are usually placed after the conclusions (@jackiekazil)

Software paper

  • A statement of need: Does the paper have a section titled 'Statement of need' that clearly states what problems the software is designed to solve, who the target audience is, and its relation to other work?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?

@jackiekazil jackiekazil requested a review from jofmi February 17, 2025 21:07
@jackiekazil
Copy link
Member Author

@jofmi - RE: statement of need -- let me know if I missed any of the requirements or suggestions.

@jackiekazil jackiekazil changed the title Jk/paper 2024 Fix Statement of Need; Acknowledgements, and Applications. Feb 17, 2025
@jackiekazil jackiekazil changed the title Fix Statement of Need; Acknowledgements, and Applications. Paper: Fix Statement of Need; Acknowledgements, and Applications. Feb 17, 2025
Copy link
Collaborator

@jofmi jofmi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good! :)

@jackiekazil jackiekazil merged commit c5b1e39 into paper_2024 Feb 19, 2025
3 checks passed
@jackiekazil jackiekazil deleted the jk/paper_2024 branch February 19, 2025 05:35
@wang-boyu wang-boyu added the docs Release notes label label Mar 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Release notes label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants