https://github.com/openmc-dev/openmc

OpenMC Monte Carlo Code
https://github.com/openmc-dev/openmc

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

Last synced: 3 months ago
JSON representation

OpenMC Monte Carlo Code

• Host: GitHub
• URL: https://github.com/openmc-dev/openmc
• Owner: openmc-dev
• License: other
• Created: 2011-07-21T00:33:27.000Z (over 13 years ago)
• Default Branch: develop
• Last Pushed: 2024-04-12T21:06:06.000Z (10 months ago)
• Last Synced: 2024-04-12T21:17:28.467Z (10 months ago)
• Topics: 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
• Language: Python
• Homepage: https://docs.openmc.org
• Size: 68.4 MB
• Stars: 687
• Watchers: 72
• Forks: 440
• Open Issues: 335
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

• awesome-nuclear - OpenMC

README

        
# OpenMC Monte Carlo Particle Transport Code

[![License](https://img.shields.io/badge/license-MIT-green)](https://docs.openmc.org/en/latest/license.html)

[![GitHub Actions build status (Linux)](https://github.com/openmc-dev/openmc/actions/workflows/ci.yml/badge.svg?branch=develop)](https://github.com/openmc-dev/openmc/actions/workflows/ci.yml)

[![Code Coverage](https://coveralls.io/repos/github/openmc-dev/openmc/badge.svg?branch=develop)](https://coveralls.io/github/openmc-dev/openmc?branch=develop)

[![dockerhub-publish-develop-dagmc](https://github.com/openmc-dev/openmc/workflows/dockerhub-publish-develop-dagmc/badge.svg)](https://github.com/openmc-dev/openmc/actions?query=workflow%3Adockerhub-publish-develop-dagmc)

[![dockerhub-publish-develop](https://github.com/openmc-dev/openmc/workflows/dockerhub-publish-develop/badge.svg)](https://github.com/openmc-dev/openmc/actions?query=workflow%3Adockerhub-publish-develop)

[![conda-pacakge](https://anaconda.org/conda-forge/openmc/badges/version.svg)](https://anaconda.org/conda-forge/openmc)

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](https://docs.openmc.org/en/stable/) and

[developmental](https://docs.openmc.org/en/latest/) version). If you are

interested in the project, or would like to help and contribute, please get in

touch on the OpenMC [discussion forum](https://openmc.discourse.group/).

## Installation

Detailed [installation

instructions](https://docs.openmc.org/en/stable/usersguide/install.html)

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](https://doi.org/10.1016/j.anucene.2014.07.048),"

  *Ann. Nucl. Energy*, **82**, 90--97 (2015).

## Troubleshooting

If you run into problems compiling, installing, or running OpenMC, first check

the [Troubleshooting

section](https://docs.openmc.org/en/stable/usersguide/troubleshoot.html) in the

User's Guide. If you are not able to find a solution to your problem there,

please post to the [discussion forum](https://openmc.discourse.group/).

## Reporting Bugs

OpenMC is hosted on GitHub and all bugs are reported and tracked through the

[Issues](https://github.com/openmc-dev/openmc/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](https://openmc.discourse.group/). 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](https://docs.openmc.org/en/stable/license.html).