| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
| Name | Name | Last commit date | ||
|---|---|---|---|---|
MontePy is the most user-friendly Python library for reading, editing, and writing MCNP input files.
Simply run:
pip install montepy
For more complicated setups see the Installing section in the user guide.
MontePy has a website documenting how to work with MCNP in python with MontePy. The website contains a user's guide for getting started, a developer's guide covering the design and approach of MontePy, instructions for contributing, and the Python API documentation.
Here is a quick example showing multiple tasks in MontePy:
import montepy
# read in file
problem = montepy.read_input("tests/inputs/test.imcnp")
# set photon importance for multiple cells
importances = {1: 0.005,
2: 0.1,
3: 1.0,
99: 1.235
}
for cell_num, importance in importances.items():
problem.cells[cell_num].importance.photon = importance
#create a universe and fill another cell with it
universe = montepy.Universe(123)
problem.universes.append(universe)
# add all cells with numbers between 1 and 4
universe.claim(problem.cells[1:5])
# fill cell 99 with universe 123
problem.cells[99].fill.universe = universe
# update all surfaces numbers by adding 1000 to them
for surface in problem.surfaces:
surface.number += 1000
# all cells using these surfaces will be automatically updated as well
#write out an updated file
problem.write_problem("foo_update.imcnp")For more examples see the getting started guide.
Here are some possible use cases for MontePy:
Here a few of the known bugs and limitations:
Here are the rough development priorities for adding new features to MontePy:
If you have a specific feature priority that you would be willing to collaborate on you can open an issue or email us at mgale@montepy.org.
There are some python packages that offer some of the same features as MontePy, but don't offer the same level of robustness, ease of installation, and user friendliness.
Many of the competitors do not offer the robustness that MontePy does because, they do not utilize context-free parsing (as of 2024). These packages are:
The only other libraries that do utilize context-free parsing that we are aware of are:
MontePy differs from MCNPy by being:
MontePy differs from mckit by being:
For only writing, or templating an input file there are also some great tools out there. These packages don't provide the same functionality as MontePy inherently, but could be the right tool for the job depending on the user's needs.
Another honorable mention that doesn't replicate the features of MontePy, but could be a great supplement to MontePy for defining materials, performing activations, etc. is PyNE --- the Nuclear Engineering Toolkit.
So MontePy doesn't do what you want? Add an issue here with the "feature request" tag. The system is very modular and you should be able to develop it pretty quickly. Read the developer's guide for more details. If you have any questions feel free to ask @micahgale.
You can cite MontePy as:
Gale et al., (2025). MontePy: a Python library for reading, editing, and writing MCNP input files. Journal of Open Source Software, 10(108), 7951, https://doi.org/10.21105/joss.07951
| Back | FazBrowse Home | New Git URL |