pymcnp 0.1.2

Python-based MCNP tools.

PyMCNP

PyMCNP enables research with Monte Carlo N-Particle (MCNP) simulations. It parses MCNP files, creates MCNP geometry visualization, and runs MCNP in parallel. PyMCNP provides a Python API for MCNP input and output files and a command line interface for interacting with MCNP and MCNP files.

Find more information on ReadTheDocs.

Installation

PyMCNP requires Python (≥ 3.10) and Numpy (≥ 2.0).

PyMCNP is distributed through the Python Package Index (PyPi) with the pip command. The following command installs both pymcnp and its depenencies:

pip install numpy pymcnp

PyMCNP source code is accessable for contributions, suggestions, and bug reports on GitHub with the git command. The following command downloads PyMCNP source code and installs pymcnp and its dependencies in editable mode:

git clone https://github.com/FSIBT/PyMCNP
cd PyMCNP
pip install -e .

Testings

To run the PyMCNP testing suite, after clone the PyMCNP GitHub repository, use the following commands to install Hypothesis (ReadTheDocs) and Pytest (Docs) inside the PyMCNP directory:

cd PyMCNP
pip install pytest hypothesis

After instaling pytest and hypothesis, test the pymcnp package by calling the following commands inside the PyMCNP directory:

cd PyMCNP
pytest --verbose

Copyright and License

For copyright and license infromation, see the COPYRIGHT and LICENSE files in the top level directory.