[REVIEW]: parsnip: Streamlined Crystallographic Data Parsing for Simulation Science

[editorialbot]

Submitting author: @janbridley (Jenna Bradley)
Repository: https://github.com/glotzerlab/parsnip.git
Branch with paper.md (empty if default branch): admin/joss
Version: v0.5.0
Editor: @lucydot
Reviewers: @ml-evs, @janash
Archive: Pending

Status

Status badge code:

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

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

@ml-evs & @janash, 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 @lucydot know.

✨ Please start on your review when you are able; the expectation is that it will take 2-4 weeks to complete. ✨

Checklists

📝 Checklist for @ml-evs

[editorialbot]

Hello humans, I'm @editorialbot, a robot that can help you with some common editorial tasks.

For a list of things I can do to help you, just type:

@editorialbot commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@editorialbot generate pdf

[editorialbot]

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

✅ OK DOIs

- 10.1107/S0108768102003464 is OK
- 10.1016/S0076-6879(97)77032-0 is OK
- 10.1088/1361-648X/aa680e is OK
- 10.1109/5992.998641 is OK
- 10.1016/j.commatsci.2019.109363 is OK
- 10.1016/j.cpc.2021.108171 is OK
- 10.21105/joss.04200 is OK
- 10.1107/S0021889806015627 is OK
- 10.1016/j.cpc.2020.107275 is OK
- 10.1351/goldbook.MT06966 is OK
- 10.1016/j.commatsci.2014.10.037 is OK
- 10.1016/j.commatsci.2012.10.028 is OK
- 10.1107/S0021889809016690 is OK
- 10.1093/nar/gky949 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: The Visualization Toolkit (4th ed.)

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

[editorialbot]

Repository Analysis Report

Code breakdown

github.com/AlDanial/cloc v 1.98  T=0.06 s (1077.8 files/s, 301624.3 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JSON                             2              0              0          12353
Python                          15            545            646           1739
Text                             8              0              0            661
reStructuredText                15            229            360            297
Markdown                         8             83             12            285
TeX                              1              5              0            264
YAML                             7             29             19            241
SVG                              4              0              1            167
TOML                             1             16              0            104
HTML                             1              1              0             70
DOS Batch                        1              8              1             26
make                             1              4              7              9
Bourne Shell                     1              2              0              7
-------------------------------------------------------------------------------
SUM:                            65            922           1046          16223
-------------------------------------------------------------------------------

Commit Count by Author

135	janbridley
    93	renovate[bot]
    32	Jen Bradley
     8	Jenna Bradley
     6	Joshua A. Anderson
     3	dependabot[bot]
     1	Kevin Mattheus Moerman

Repository History

Repository age: First commit on March 28, 2024

Code distribution (top 3 48-hour windows):

Period	Insertions	% of Total	Signal	View Changes
Feb 04, 2026 - Feb 06, 2026	25733	57.8%	🟠	View diff
Apr 08, 2024 - Apr 10, 2024	3004	6.8%	🟢	View diff
May 20, 2024 - May 22, 2024	2068	4.6%	🟢	View commit

GitHub Activity Metrics

Metric	Count
GitHub stars	4
Forks	2
GitHub contributors	4
Releases	7
Total issues	14
Total pull requests	183
Unique commenters/reviewers (excluding authors)	7

[editorialbot]

Paper file info:

⚠️ Wordcount for paper.md is 1904

✅ The paper includes a Statement of need section

✅ The paper includes a State of the field section

✅ The paper includes a Software design section

✅ The paper includes a Research impact statement section

✅ The paper includes an AI usage disclosure section

[editorialbot]

License info:

✅ License found: BSD 3-Clause "New" or "Revised" License (Valid open source OSI approved license)

[editorialbot]

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

[ml-evs]

Review checklist for @ml-evs

AI usage

• I confirm that I have read the JOSS AI policy and understand that:
  • AI may only be used for non-substantive assistance (e.g., grammar checking my review text, contextualizing public materials)
  • All evaluative decisions—including scoring, accept/reject recommendations, and assessments of originality, correctness, significance, and ethics compliance—must be made exclusively by me, not AI
  • I bear full responsibility for all judgments, recommendations, and technical claims in my review
  • I will disclose any AI assistance at the conclusion of my review

Conflict of interest

• I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

• I confirm that I read and will adhere to the JOSS code of conduct.

General checks

• Repository: Is the source code for this software available at the https://github.com/glotzerlab/parsnip.git?
• License: Does the repository contain a plain-text LICENSE or COPYING file with the contents of an OSI approved software license?
• Contribution and authorship: Has the submitting author (@janbridley) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
• Scope and significance: Does this submission demonstrate clear research impact or credible scholarly significance as described in the JOSS guidelines?
• Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
• Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
• Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

Development history and open-source practice

• Development timeline: Does the project show evidence of sustained development over time (preferably months or years) rather than rapid, recent code generation?
• Open development: Was the software developed openly from early stages? For projects with recent public repositories, is there at least six months of public development history with evidence of releases, public issues/pull requests, and ideally external engagement?
• Collaborative effort: Does the project show evidence of community engagement such as contributions from multiple developers, issues/discussions from external users, or community influence on the development described in the paper?
• Good practices: Does the project look like a reusable, non-throwaway research software project that follows good open-source practices (license, documentation, tests and/or verification processes, releases, and clear contribution/support pathways).

Functionality

• Installation: Does installation proceed as outlined in the documentation?
• Functionality: Have the functional claims of the software been confirmed?
• Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

• A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
• Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
• Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
• Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
• Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
• Community guidelines: Are there clear guidelines for third parties wishing to 1. Contribute to the software 2. Report issues or problems with the software 3. Seek support

Software paper

• Summary (required section): Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
• A statement of need (required section): 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 (required section): Do the authors describe how this software compares to other commonly-used packages? If related tools exist, do they provide a clear "build vs. contribute" justification explaining their unique scholarly contribution and why alternatives are insufficient?
• Software Design (required section): Does the paper include a "Software Design" section that explains the trade-offs weighed, the design/architecture chosen, and why it matters? Is the content compelling and does it demonstrate meaningful design thinking?
• Research Impact Statement (required section): Does the paper include a "Research Impact Statement" section providing evidence of realized impact (publications, external use, integrations) or credible near-term significance (benchmarks, reproducible materials, community-readiness signals)? Is the evidence presented compelling?
• AI usage disclosure (required section): Does the paper include an "AI usage disclosure" section that transparently discloses any use of generative AI in the software creation, documentation, or paper authoring?
• Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
• References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?