MontePy Submission

[MicahGale]

Submitting Author: @MicahGale
All current maintainers: @MicahGale, @tjlaboss
Package Name: MontePy
One-Line Description of Package: MontePy is a python library for reading, editing, and writing MCNP input files.
Repository Link: https://github.com/idaholab/MontePy
Version submitted: 0.3.3
EiC: @cmarmo
Editor: @kellyrowland
Reviewer 1: @Munkn
Reviewer 2: @jpmorgan98
Archive: TBD
JOSS DOI: TBD
Version accepted: TBD
Date accepted (month/day/year): TBD

---

Code of Conduct & Commitment to Maintain Package

• I agree to abide by pyOpenSci's Code of Conduct during the review process and in maintaining my package after should it be accepted.
• I have read and will commit to package maintenance after the review as per the pyOpenSci Policies Guidelines.

Description

• Include a brief paragraph describing what your package does:

MontePy is a Python library for reading, editing, and writing MCNP input files. MCNP is the Monte Carlo N-Particle radiation transport code that supports 37 particle types, and is widely used in Nuclear Engineering, and Medical Physics. MontePy provides an object-oriented interface for MCNP input files. This allows for easy automation of many different tasks for working with MCNP input files. MontePy does not support MCNP output files

Scope

• Please indicate which category or categories.
  Check out our package scope page to learn more about our
  scope. (If you are unsure of which category you fit, we suggest you make a pre-submission inquiry):

  • Data retrieval
  • Data extraction
  • Data processing/munging
  • Data deposition
  • Data validation and testing
  • Data visualization¹
  • Workflow automation
  • Citation management and bibliometrics
  • Scientific software wrappers
  • Database interoperability

Domain Specific

• Geospatial
• Education

Community Partnerships

If your package is associated with an
existing community please check below:

• Astropy:My package adheres to Astropy community standards
• Pangeo: My package adheres to the Pangeo standards listed in the pyOpenSci peer review guidebook

• For all submissions, explain how and why the package falls under the categories you indicated above. In your explanation, please address the following points (briefly, 1-2 sentences for each):

  • Who is the target audience and what are scientific applications of this package?

    • Scientists and engineers who use MCNP and know python are the primary audience. This will be mostly nuclear engineers, and medical physicists. Use cases are:

    • Automating tedious updates of simulation models (e.g., renumbering all materials to merge two models)

    • Automating generating many permutations of the model for optimization, sensitivity analysis, etc.

    • Extracting information from an existing model in a more legible way.

  • Are there other Python packages that accomplish the same thing? If so, how does yours differ?

    • There is also MCNPy, which reports to provide similar features. I have been unable to verify this as I have been unable to install it. MontePy is different by being written purely in python, and not java, and having a publicly accessible github, that anyone can open an issue for.

  • If you made a pre-submission enquiry, please paste the link to the corresponding issue, forum post, or other discussion, or @tag the editor you contacted:

    • This is a follow on to the presubmission inquiry: Presubmission Inquiry for MontePy #203.

Technical checks

For details about the pyOpenSci packaging requirements, see our packaging guide. Confirm each of the following by checking the box. This package:

• does not violate the Terms of Service of any service it interacts with.
• uses an OSI approved license.
• contains a README with instructions for installing the development version.
• includes documentation with examples for all functions.
• contains a tutorial with examples of its essential functions and uses.
• has a test suite.
• has continuous integration setup, such as GitHub Actions CircleCI, and/or others.

Publication Options

• Do you wish to automatically submit to the Journal of Open Source Software? If so:

JOSS Checks

• The package has an obvious research application according to JOSS's definition in their submission requirements. Be aware that completing the pyOpenSci review process does not guarantee acceptance to JOSS. Be sure to read their submission requirements (linked above) if you are interested in submitting to JOSS.
• The package is not a "minor utility" as defined by JOSS's submission requirements: "Minor ‘utility’ packages, including ‘thin’ API clients, are not acceptable." pyOpenSci welcomes these packages under "Data Retrieval", but JOSS has slightly different criteria.
• The package contains a paper.md matching JOSS's requirements with a high-level description in the package root or in inst/.
• The package is deposited in a long-term repository with the DOI:

Note: JOSS accepts our review as theirs. You will NOT need to go through another full review. JOSS will only review your paper.md file. Be sure to link to this pyOpenSci issue when a JOSS issue is opened for your package. Also be sure to tell the JOSS editor that this is a pyOpenSci reviewed package once you reach this step.

Are you OK with Reviewers Submitting Issues and/or pull requests to your Repo Directly?

This option will allow reviewers to open smaller issues that can then be linked to PR's rather than submitting a more dense text based review. It will also allow you to demonstrate addressing the issue via PR links.

• Yes I am OK with reviewers submitting requested changes as issues to my repo. Reviewers will then link to the issues in their submitted review.

Confirm each of the following by checking the box.

• I have read the author guide.
• I expect to maintain this package for at least 2 years and can help find a replacement for the maintainer (team) if needed.

Please fill out our survey

• Last but not least please fill out our pre-review survey. This helps us track
  submission and improve our peer review process. We will also ask our reviewers
  and editors to fill this out.

P.S. Have feedback/comments about our review process? Leave a comment here

Editor and Review Templates

The editor template can be found here.

The review template can be found here.

Footnotes

1. Please fill out a pre-submission inquiry before submitting a data visualization package. ↩

[cmarmo]

Editor in Chief checks

Hi @MicahGale ! Thank you for submitting your package for pyOpenSci review.
Below are the basic checks that your package needs to pass to begin our review.
If some of these are missing, we will ask you to work on them before the review process begins.

Please check our Python packaging guide for more information on the elements
below.

• Installation The package can be installed from a community repository such as PyPI (preferred), and/or a community channel on conda (e.g. conda-forge, bioconda).
  • The package imports properly into a standard Python environment import package.
• Fit The package meets criteria for fit and overlap.
• Documentation The package has sufficient online documentation to allow us to evaluate package function and scope without installing the package. This includes:
  • User-facing documentation that overviews how to install and start using the package.
  • Short tutorials that help a user understand how to use the package and what it can do for them.
  • API documentation (documentation for your code's functions, classes, methods and attributes): this includes clearly written docstrings with variables defined using a standard docstring format.
• Core GitHub repository Files
  • README The package has a README.md file with clear explanation of what the package does, instructions on how to install it, and a link to development instructions.
  • Contributing File The package has a CONTRIBUTING.md file that details how to install and contribute to the package.
  • Code of Conduct The package has a CODE_OF_CONDUCT.md file.
  • License The package has an OSI approved license.
    NOTE: We prefer that you have development instructions in your documentation too.
• Issue Submission Documentation All of the information is filled out in the YAML header of the issue (located at the top of the issue template).
• Automated tests Package has a testing suite and is tested via a Continuous Integration service.
• Repository The repository link resolves correctly.
• Package overlap The package doesn't entirely overlap with the functionality of other packages that have already been submitted to pyOpenSci.
• Archive (JOSS only, may be post-review): The repository DOI resolves correctly.
• Version (JOSS only, may be post-review): Does the release version given match the GitHub release (v1.0.0)?

---

• Initial onboarding survey was filled out
  We appreciate each maintainer of the package filling out this survey individually. 🙌
  Thank you authors in advance for setting aside five to ten minutes to do this. It truly helps our organization. 🙌

---

---

Editor comments

MontePy is in very good shape, congratulations to all the maintainers for your hard work!

Some comments about the checklist above.

• In the documentation about the installation of a specific version : I strongly recommend to remove any manual process creating symbolic links and installing requirements in a folder. Virtual environments should always be preferred and you can install specific versions/tags/branches or commit in them with

pip install git+https://github.com/idaholab/MontePy.git@<your-version/tag/branch/commit>

• The README.md redirects to the documentation for details about the installation: may I suggest to explicitely add the command pip install? This will clarify that the package is available from pypi but not from any conda channel.
• The code of conduct is linked in contributing.md (btw thanks for expliciting the contact e-mail) but the file is missing and the link gives a "404 not found".

Minor comments not needed to start the review:

• the documentation generally moves from more readable contents to more technical and detailed contents: I would have put the API at the end of the documentation.
• wearing my data processing engineer hat, I would be grateful to have a safe default option backupping original files when overwriting ... I was checking basic usage documentation and the behaviour of your writing function really scared me.... 😅

Final note: I enjoyed this quote from your documentation 🪄

Creating a new universe is very straight forward. You just need to initialize it with a new number

[MicahGale]

@cmarmo thank you for the feedback!

I have opened this PR: idaholab/MontePy#440 to address this feedback.

In the documentation about the installation of a specific version : I strongly recommend to remove any manual process creating symbolic links and installing requirements in a folder. Virtual environments should always be preferred and you can install specific versions/tags/branches or commit in them with

These directions are old and from when this was an internal tool. I just removed them and instead pointed to using pip install montepy==<version>. Most versions are on PyPI, and those that aren't, can't be because they don't have an OSS license yet. So if someone really wants that old of a version I think they will figure it out on their own how to manage.

The README.md redirects to the documentation for details about the installation: may I suggest to explicitely add the command pip install? This will clarify that the package is available from pypi but not from any conda channel.

Added the command.

The code of conduct is linked in contributing.md (btw thanks for expliciting the contact e-mail) but the file is missing and the link gives a "404 not found".

Corrected this and actually added a boilerplate code of conduct.

the documentation generally moves from more readable contents to more technical and detailed contents: I would have put the API at the end of the documentation.

Good point. I updated the index to list the API documentation last.

wearing my data processing engineer hat, I would be grateful to have a safe default option backupping original files when overwriting ... I was checking basic usage documentation and the behaviour of your writing function really scared me.... 😅

This warning was written when MontePy used to discard user formatting and comments, which is no longer the case. write_to_file has no default option that would override the original file. I think now the only real risk with overwriting the original file is having a script that is buggy and accidentally changing the model. I changed the warning to discourage this sort of workflow for making script development easier.

After more consideration (mostly from others) I think this behavior should be changed, and an issue has been opened: idaholab/MontePy#442.

Final note: I enjoyed this quote from your documentation 🪄

Creating a new universe is very straight forward. You just need to initialize it with a new number

I forget sometimes about how silly the concept of universes are in these models is sometimes especially when working with them.

[cmarmo]

Thank you @MicahGale for your prompt response to my comments.
Let me know when your PR is merged so I can start looking for an editor.

[MicahGale]

Ok this PR has been merged.

[cmarmo]

Thank you @MicahGale !
Your package looks ready for review to me.

I noticed that you submitted to JOSS independently (see openjournals/joss-reviews#6977): may I suggest to merge the two submissions, as pyOpenSci has a partnership with JOSS.
This will also lower the pression on our two communities, as both pyOpenSci and JOSS are based on volounteer engagement.
If you are ok with that I can comment on the related JOSS issue and we can follow up here.

[MicahGale]

Yes let's merge them if that makes sense. I just did things in a bit of a different order.

[cmarmo]

Hello @MicahGale , I'm glad to announce that @kellyrowland has accepted to be editor for the MontePy review.
Thank you so much Kelly!

I'm letting her introduce herself here and I wish to all of you a happy review process! 🚀 :

[kellyrowland]

Hi -

This is my first engagement with pyOpenSci, so thanks in advance for your patience. 😅 I've been an editor for JOSS for a few years, and that's how we've arrived here.

@MicahGale before I get started on finding reviewers, I see there are a set of JOSS-related boxes to tick off - can you take a look at those and check them off/open PRs/etc. and let me know about the status of those items?

Thanks for tagging some possible reviewers over in openjournals/joss-reviews#6977 - I'll ping folks in this issue and make a post with the editor template once we've got two reviewers on board.

-Kelly

[MicahGale]

Thank you for being willing to do this new role for this package. :)

Ok I updated the JOSS section accordingly.

The one concern I had was about getting a DOI for archiving the software. Under the JOSS guidelines it seems like that's a final step?

Upon successful completion of the review, authors will make a tagged release of the software, and deposit a copy of the repository with a data-archiving service such as Zenodo or figshare, get a DOI for the archive, and update the review issue thread with the version number and DOI.

Are you alright with following the JOSS order for this?

[kellyrowland]

Good point, thanks. I think archiving the release and getting a DOI is a logical last step since it's often the case that changes are made to the software during the review process.

[kellyrowland]

@cmarmo it looks like the remaining "Core GitHub repository Files" item is set - could you please take a look and check that off at your earliest convenience? I think I should be set to ping potential reviewers at that point.

[cmarmo]

Done! Thank you Kelly!

[kellyrowland]

hi @paulromano @munkm 👋 would you be interested in and available to review this pyOpenSci submission?

the reviewer template that you would use can be seen at https://www.pyopensci.org/software-peer-review/appendices/templates.html#peer-review-template .

if you're not available for the review, could you suggest other potential reviewers for the package?

[munkm]

I would love to! But I won't be able to review until after September 15th. Will that be an issue? If it is, I'll suggest an alternate.

[kellyrowland]

@MicahGale does the above timeline work for you?

[MicahGale]

Yes, @kellyrowland, @munkm that timeline works me.

[kellyrowland]

hello @jpmorgan98 @gwenchee 👋 would you be interested in and available to review this pyOpenSci submission?

the reviewer template that you would use can be seen at https://www.pyopensci.org/software-peer-review/appendices/templates.html#peer-review-template .

[jpmorgan98]

@kellyrowland I am willing! However, I will not be available until Sept. 31st. Let me know if that's an issue

[MicahGale]

@jpmorgan98, I am fine with that. I understand end of the federal fiscal year crunch time.

[kellyrowland]

thanks all! I think we can assign the reviewers and then I'll check back in...

@cmarmo is that something you could do, edit the anchor post to add the reviewers? I don't think I'm able to as a drop-in editor here.