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

Add munkm feedback to JOSS paper #649

Open
wants to merge 6 commits into
base: joss_submit
Choose a base branch
from
Open

Conversation

MicahGale
Copy link
Collaborator

@MicahGale MicahGale commented Jan 29, 2025

Pull Request Checklist for MontePy

Description

This is for the feedback in #646 that is related to the joss paper as those shouldn't be merged into develop.

Fixes #646, Fixes #433.


General Checklist

  • I have performed a self-review of my own code.
  • The code follows the standards outlined in the development documentation.
  • I have added tests that prove my fix is effective or that my feature works (if applicable).

Documentation Checklist

  • I have documented all added classes and methods.
  • For infrastructure updates, I have updated the developer's guide.
  • For significant new features, I have added a section to the getting started guide.

First-Time Contributor Checklist

  • If this is your first contribution, add yourself to pyproject.toml if you wish to do so.

Additional Notes for Reviewers

Ensure that:

  • The submitted code is consistent with the merge checklist outlined here.
  • The PR covers all relevant aspects according to the development guidelines.
  • 100% coverage of the patch is achieved, or justification for a variance is given.

📚 Documentation preview 📚: https://montepy--649.org.readthedocs.build/en/649/

@MicahGale
Copy link
Collaborator Author

TODO: manually close #433 as this isn't merging into develop.

@MicahGale MicahGale marked this pull request as ready for review February 3, 2025 04:24
@MicahGale MicahGale requested a review from tjlaboss February 3, 2025 04:24
@MicahGale MicahGale added the documentation Improvements or additions to documentation label Feb 3, 2025
@MicahGale MicahGale added this to the joss milestone Feb 3, 2025
Comment on lines +115 to +314

@software{shimwell_neutronics_2024,
title = {Neutronics Material Maker},
url = {https://github.com/fusion-energy/neutronics_material_maker},
version = {1.2.1},
author = {Shimwell, Jonathan and Billingsley, John and Buendia, Coronel and {Neutronics Material Material Contributors}},
date = {2024},
keywords = {input templater},
}

@software{repositony_vscode_mcnp_2024,
title = {vscode\_mcnp},
url = {https://github.com/repositony/vscode_mcnp},
author = {{Repositony}},
date = {2024},
keywords = {syntax highlighter},
}

@software{turkoglu_mcnp-syntax-highlighting_2018,
title = {{MCNP}-syntax-highlighting},
url = {https://github.com/danyalturkoglu/MCNP-syntax-highlighting},
author = {Turkoglu, Danyal},
date = {2018},
keywords = {syntax highlighter},
}

@software{mancusi_t4_geom_convert_2024,
title = {t4\_geom\_convert},
url = {https://github.com/arekfu/t4_geom_convert},
version = {1.1.2},
author = {Mancusi, Davide},
date = {2024},
keywords = {conversions, converter, read input},
}

@software{pease_pymcnp_2025,
title = {{PyMCNP}},
url = {https://github.com/FSIBT/PyMCNP},
author = {Pease, Devin and Ayllon Unzueta, Mauricio and Surry, Emily and Persaud, Arun},
date = {2025},
keywords = {input {API}},
}

@software{portnov_map-stp_2024,
title = {map-stp},
url = {https://github.com/MC-kit/map-stp},
author = {Portnov, Dimitri},
date = {2024},
keywords = {input templater},
}

@software{hung_mcnp6-hpge_detector_simulation_2023,
title = {{MCNP}6-{HPGE}\_Detector\_Simulation},
url = {https://github.com/hungbt1908/MCNP6-HPGE_Detector_Simulation},
author = {Hung, Bui Tien},
date = {2023},
keywords = {specific problem automation},
}

@software{galdon_bemp_thesis_2024,
title = {{BEMP}\_Thesis},
url = {https://github.com/mgaldon17/BEMP_Thesis},
version = {1.0.0},
author = {Galdon, Manuel},
date = {2024},
keywords = {specific problem automation},
}

@software{niess_gdnp_2018,
title = {{GDNP}},
url = {https://github.com/niess/gdnp},
author = {{niess}},
date = {2018},
keywords = {input templater},
}

@software{richet_funz_2023,
title = {Funz Plugin-{MCNP}},
url = {https://github.com/Funz/plugin-MCNP},
version = {1.16-0},
author = {Richet, Yann},
date = {2023},
keywords = {input templater},
}

@software{ikarino_mcnp_2021,
title = {{MCNP} Input Generator},
url = {https://github.com/ikarino/mcnp_input_generator},
author = {{ikarino}},
date = {2021},
keywords = {input templater},
}

@software{park_rodcal-mcnp_2021,
title = {rodcal-mcnp},
url = {https://github.com/patrickpark910/rodcal-mcnp},
author = {Park, Patrick},
date = {2021},
keywords = {specific problem automation},
}
Copy link
Collaborator

Choose a reason for hiding this comment

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

References are triplicated.

Comment on lines +315 to +513

@software{shimwell_neutronics_2024,
title = {Neutronics Material Maker},
url = {https://github.com/fusion-energy/neutronics_material_maker},
version = {1.2.1},
author = {Shimwell, Jonathan and Billingsley, John and Buendia, Coronel and {Neutronics Material Material Contributors}},
date = {2024},
keywords = {input templater},
}

@software{repositony_vscode_mcnp_2024,
title = {vscode\_mcnp},
url = {https://github.com/repositony/vscode_mcnp},
author = {{Repositony}},
date = {2024},
keywords = {syntax highlighter},
}

@software{turkoglu_mcnp-syntax-highlighting_2018,
title = {{MCNP}-syntax-highlighting},
url = {https://github.com/danyalturkoglu/MCNP-syntax-highlighting},
author = {Turkoglu, Danyal},
date = {2018},
keywords = {syntax highlighter},
}

@software{mancusi_t4_geom_convert_2024,
title = {t4\_geom\_convert},
url = {https://github.com/arekfu/t4_geom_convert},
version = {1.1.2},
author = {Mancusi, Davide},
date = {2024},
keywords = {conversions, converter, read input},
}

@software{pease_pymcnp_2025,
title = {{PyMCNP}},
url = {https://github.com/FSIBT/PyMCNP},
author = {Pease, Devin and Ayllon Unzueta, Mauricio and Surry, Emily and Persaud, Arun},
date = {2025},
keywords = {input {API}},
}

@software{portnov_map-stp_2024,
title = {map-stp},
url = {https://github.com/MC-kit/map-stp},
author = {Portnov, Dimitri},
date = {2024},
keywords = {input templater},
}

@software{hung_mcnp6-hpge_detector_simulation_2023,
title = {{MCNP}6-{HPGE}\_Detector\_Simulation},
url = {https://github.com/hungbt1908/MCNP6-HPGE_Detector_Simulation},
author = {Hung, Bui Tien},
date = {2023},
keywords = {specific problem automation},
}

@software{galdon_bemp_thesis_2024,
title = {{BEMP}\_Thesis},
url = {https://github.com/mgaldon17/BEMP_Thesis},
version = {1.0.0},
author = {Galdon, Manuel},
date = {2024},
keywords = {specific problem automation},
}

@software{niess_gdnp_2018,
title = {{GDNP}},
url = {https://github.com/niess/gdnp},
author = {{niess}},
date = {2018},
keywords = {input templater},
}

@software{richet_funz_2023,
title = {Funz Plugin-{MCNP}},
url = {https://github.com/Funz/plugin-MCNP},
version = {1.16-0},
author = {Richet, Yann},
date = {2023},
keywords = {input templater},
}

@software{ikarino_mcnp_2021,
title = {{MCNP} Input Generator},
url = {https://github.com/ikarino/mcnp_input_generator},
author = {{ikarino}},
date = {2021},
keywords = {input templater},
}

@software{park_rodcal-mcnp_2021,
title = {rodcal-mcnp},
url = {https://github.com/patrickpark910/rodcal-mcnp},
author = {Park, Patrick},
date = {2021},
keywords = {specific problem automation},
}
Copy link
Collaborator

Choose a reason for hiding this comment

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

2/3

Comment on lines +514 to +712

@software{shimwell_neutronics_2024,
title = {Neutronics Material Maker},
url = {https://github.com/fusion-energy/neutronics_material_maker},
version = {1.2.1},
author = {Shimwell, Jonathan and Billingsley, John and Buendia, Coronel and {Neutronics Material Material Contributors}},
date = {2024},
keywords = {input templater},
}

@software{repositony_vscode_mcnp_2024,
title = {vscode\_mcnp},
url = {https://github.com/repositony/vscode_mcnp},
author = {{Repositony}},
date = {2024},
keywords = {syntax highlighter},
}

@software{turkoglu_mcnp-syntax-highlighting_2018,
title = {{MCNP}-syntax-highlighting},
url = {https://github.com/danyalturkoglu/MCNP-syntax-highlighting},
author = {Turkoglu, Danyal},
date = {2018},
keywords = {syntax highlighter},
}

@software{mancusi_t4_geom_convert_2024,
title = {t4\_geom\_convert},
url = {https://github.com/arekfu/t4_geom_convert},
version = {1.1.2},
author = {Mancusi, Davide},
date = {2024},
keywords = {conversions, converter, read input},
}

@software{pease_pymcnp_2025,
title = {{PyMCNP}},
url = {https://github.com/FSIBT/PyMCNP},
author = {Pease, Devin and Ayllon Unzueta, Mauricio and Surry, Emily and Persaud, Arun},
date = {2025},
keywords = {input {API}},
}

@software{portnov_map-stp_2024,
title = {map-stp},
url = {https://github.com/MC-kit/map-stp},
author = {Portnov, Dimitri},
date = {2024},
keywords = {input templater},
}

@software{hung_mcnp6-hpge_detector_simulation_2023,
title = {{MCNP}6-{HPGE}\_Detector\_Simulation},
url = {https://github.com/hungbt1908/MCNP6-HPGE_Detector_Simulation},
author = {Hung, Bui Tien},
date = {2023},
keywords = {specific problem automation},
}

@software{galdon_bemp_thesis_2024,
title = {{BEMP}\_Thesis},
url = {https://github.com/mgaldon17/BEMP_Thesis},
version = {1.0.0},
author = {Galdon, Manuel},
date = {2024},
keywords = {specific problem automation},
}

@software{niess_gdnp_2018,
title = {{GDNP}},
url = {https://github.com/niess/gdnp},
author = {{niess}},
date = {2018},
keywords = {input templater},
}

@software{richet_funz_2023,
title = {Funz Plugin-{MCNP}},
url = {https://github.com/Funz/plugin-MCNP},
version = {1.16-0},
author = {Richet, Yann},
date = {2023},
keywords = {input templater},
}

@software{ikarino_mcnp_2021,
title = {{MCNP} Input Generator},
url = {https://github.com/ikarino/mcnp_input_generator},
author = {{ikarino}},
date = {2021},
keywords = {input templater},
}

@software{park_rodcal-mcnp_2021,
title = {rodcal-mcnp},
url = {https://github.com/patrickpark910/rodcal-mcnp},
author = {Park, Patrick},
date = {2021},
keywords = {specific problem automation},
}
Copy link
Collaborator

Choose a reason for hiding this comment

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

3/3

Comment on lines +127 to +132
PyNE can create MCNP input files for specific features, and extract some data from MCNP output files,
however its true capabilities extend far beyond interfacing with MCNP.
It can: simplify material creation, analyzing cross section data,
complete transmutations for complex systems,
interface with other common nuclear engineering software,
and common nuclear data formats [@Scopatz:2012].
Copy link
Collaborator

Choose a reason for hiding this comment

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

I suggest:

PyNE can create MCNP input files for specific features and extract some data from MCNP output files.
However, its full capabilities extend far beyond interfacing with MCNP.
PyNE can simplify material creations, analyses of cross section data, transmutations of complex systems, and interfacing with other common nuclear engineering software and data formats.

Copy link
Collaborator

Choose a reason for hiding this comment

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

In formal writing, colons shouldn't separate a phrase. Something like, "It can do several things:" is permissible.

The rest fixes parallelism. I shouldn't really mix a gerund ("interfacing") with the other nouns, but stating that it simplifies "interfaces" might change the implication.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation PyOpenSci / JOSS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants