|
|
||
|---|---|---|
| .github | ||
| cmake | ||
| docs | ||
| examples | ||
| include/openmc | ||
| man/man1 | ||
| openmc | ||
| scripts | ||
| src | ||
| tests | ||
| tools | ||
| vendor | ||
| .clang-format | ||
| .git-blame-ignore-revs | ||
| .gitignore | ||
| .gitmodules | ||
| .readthedocs.yaml | ||
| CMakeLists.txt | ||
| CODE_OF_CONDUCT.md | ||
| CODEOWNERS | ||
| CONTRIBUTING.md | ||
| Dockerfile | ||
| LICENSE | ||
| MANIFEST.in | ||
| pyproject.toml | ||
| pytest.ini | ||
| README.md | ||
OpenMC Monte Carlo Particle Transport Code
The OpenMC project aims to provide a fully-featured Monte Carlo particle transport code based on modern methods. It is a constructive solid geometry, continuous-energy transport code that uses HDF5 format cross sections. The project started under the Computational Reactor Physics Group at MIT.
Complete documentation on the usage of OpenMC is hosted on Read the Docs (both for the latest release and developmental version). If you are interested in the project, or would like to help and contribute, please get in touch on the OpenMC discussion forum.
Installation
Detailed installation instructions can be found in the User's Guide.
Citing
If you use OpenMC in your research, please consider giving proper attribution by citing the following publication:
- Paul K. Romano, Nicholas E. Horelik, Bryan R. Herman, Adam G. Nelson, Benoit Forget, and Kord Smith, "OpenMC: A State-of-the-Art Monte Carlo Code for Research and Development," Ann. Nucl. Energy, 82, 90--97 (2015).
Troubleshooting
If you run into problems compiling, installing, or running OpenMC, first check the Troubleshooting section in the User's Guide. If you are not able to find a solution to your problem there, please post to the discussion forum.
Reporting Bugs
OpenMC is hosted on GitHub and all bugs are reported and tracked through the Issues feature on GitHub. However, GitHub Issues should not be used for common troubleshooting purposes. If you are having trouble installing the code or getting your model to run properly, you should first send a message to the discussion forum. If it turns out your issue really is a bug in the code, an issue will then be created on GitHub. If you want to request that a feature be added to the code, you may create an Issue on github.
License
OpenMC is distributed under the MIT/X license.