crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-21 06:25:30 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
OpenMC Monte Carlo Code https://docs.openmc.org
2332 commits 16 branches 33 tags 273 MiB
Find a file
Exact
Bryan Herman d1bcf74cb8 switch back to 2g solver
2014-04-18 10:06:34 -04:00
data Make get_nndc_data.py compatible with Python 3. 2014-02-19 18:12:38 -05:00
docs Merge branch 'release-v0.5.4' into develop 2014-03-25 23:09:41 -04:00
examples Added pin-cell example model. 2013-03-23 10:43:16 -04:00
man/man1 Happy new year 2014! 2014-01-14 21:44:48 -05:00
src switch back to 2g solver 2014-04-18 10:06:34 -04:00
tests Merge branch 'develop' into cmfd_rbgs 2014-03-27 11:05:10 -04:00
.gitignore Change back to using -DGIT_SHA1. 2014-03-11 23:50:10 -04:00
LICENSE Happy new year 2014! 2014-01-14 21:44:48 -05:00
readme.rst Updated links in readme.rst. 2013-04-09 22:03:45 -04:00
schemas.xml Added back RELAX NG compact schemata. 2013-08-15 00:36:49 -05:00
signal.patch Updated signal.patch. 2013-01-31 10:49:30 -05:00

readme.rst 

==========================================
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 ACE format cross sections. The
project started under the Computational Reactor Physics Group at MIT.

Complete documentation on the usage of OpenMC is hosted on GitHub at
http://mit-crpg.github.io/openmc/. 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.

---------------
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_.

.. _mailing list: https://groups.google.com/forum/?fromgroups=#!forum/openmc-users
.. _installation instructions: http://mit-crpg.github.io/openmc/usersguide/install.html
.. _Troubleshooting section: http://mit-crpg.github.io/openmc/usersguide/troubleshoot.html
.. _Issues: https://github.com/mit-crpg/openmc/issues
.. _license: http://mit-crpg.github.io/openmc/license.html