crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-25 12:35:29 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
OpenMC Monte Carlo Code https://docs.openmc.org
3082 commits 15 branches 33 tags 283 MiB
Find a file
Sterling Harper 09a2fc042e Added hexagonal example for #331
2015-03-10 02:28:02 -04:00
data fix a bug bug with VERIFY MD5 CHECKSUMS 2015-02-25 10:10:34 +08:00
docs Updated HDF5 summary with complete hexagonal lattice specifications 2015-02-26 13:43:14 -05:00
examples Added hexagonal example for #331 2015-03-10 02:28:02 -04:00
man/man1 Updated copyright date on license to 2015 2015-02-02 10:46:38 -05:00
src Begun coding hex lattice output format for #331 2015-03-10 02:20:03 -04:00
tests Merged in hex lattices 2015-02-26 13:29:26 -05:00
.gitignore Added data/nndc to .gitignore. 2014-04-14 20:04:03 -04:00
.gitmodules Changed fox URL to a public URL 2014-06-23 14:28:02 +02:00
.travis.yml fetching nndc xs from git repo 2015-02-20 17:04:08 -05:00
LICENSE Updated copyright date on license to 2015 2015-02-02 10:46:38 -05:00
readme.rst switched build status to mit-crpg account 2015-02-20 22:40:05 -05: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
==========================================

.. image:: https://travis-ci.org/mit-crpg/openmc.svg?branch=develop
    :target: https://travis-ci.org/mit-crpg/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 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