crp/OpenMC

mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-23 19:45:34 -04:00

OpenMC Monte Carlo Code https://docs.openmc.org

computational-physics high-performance-computing monte-carlo-simulation neutron-transport neutronics nuclear-data nuclear-energy nuclear-engineering nuclear-fusion openmc particle-transport photon-transport radiation-transport

Find a file

Patrick Shriwise abd417c5f6 Updating other signatures to match new pixels_ type.		2019-03-19 08:44:36 -05:00
cmake/Modules	Adding check for DAGMC_ROOT in environment as a hint.	2018-10-01 10:38:16 -05:00
docs	Add one publication to list	2019-03-12 11:42:51 -05:00
examples	Use lower-case argument names for surfaces consistently	2019-03-08 11:25:26 -06:00
include/openmc	Updating other signatures to match new pixels_ type.	2019-03-19 08:44:36 -05:00
man/man1	Remove option to specify multipole library outside of cross_sections.xml	2018-11-12 13:35:29 -06:00
openmc	Updates to mirror changes in pixels_ type in plot.cpp.	2019-03-19 08:44:36 -05:00
scripts	Bumping major version of voxel file rather than minor.	2019-02-28 09:05:47 -06:00
src	Updating other signatures to match new pixels_ type.	2019-03-19 08:44:36 -05:00
tests	A couple capi.plot module fixes and an added test.	2019-03-19 08:44:36 -05:00
tools/ci	Update nndc test data	2019-03-10 14:51:03 -05:00
vendor	Finish converting windowed multipole functions to C++	2019-01-02 13:55:08 -06:00
.gitignore	Adding VTK image format to ignore.	2018-10-07 19:36:20 -05:00
.gitmodules	Replace FoX with pugixml	2017-03-03 09:17:49 -06:00
.travis.yml	Remove mention of Fortran in documentation	2019-02-21 22:44:24 -06:00
CMakeLists.txt	Make HDF5 includes and MAX_COORD transitive (since they are needed in header files)	2019-03-13 11:02:38 -05:00
CODE_OF_CONDUCT.md	Clarify enforcement in code of conduct	2018-07-25 06:30:26 -05:00
CONTRIBUTING.md	Document governance model discussed at OpenMC developer's meeting	2018-08-03 13:01:45 -05:00
Dockerfile	Changes suggested by @liangjg	2018-11-13 10:52:53 -06:00
LICENSE	Add 'contributors' to copyright	2018-08-02 13:32:24 -05:00
MANIFEST.in	Use PEP 518 pyproject.toml file to manage build dependencies	2018-08-16 12:00:39 -05:00
pyproject.toml	Use PEP 518 pyproject.toml file to manage build dependencies	2018-08-16 12:00:39 -05:00
pytest.ini	Skip multipole-related tests if OPENMC_MULTIPOLE_LIBRARY is not set	2018-02-06 13:27:01 -05:00
README.md	change mit-crpg -> openmc-dev	2018-08-02 10:49:40 -05:00
schemas.xml	So begins the CMFD Fortran purge :D (~3.6K lines)	2018-11-24 00:13:37 -05:00
setup.py	updated package_data in setup with AME 2016	2019-02-15 14:20:03 +00:00

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 send a message to the OpenMC User's Group mailing list.

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 send a message to the User's Group mailing list.

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 User's Group mailing list. 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.