crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-21 14:35:27 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
OpenMC Monte Carlo Code https://docs.openmc.org
1418 commits 16 branches 33 tags 274 MiB
Find a file
Paul Romano 540bb7dc67 Add tallies.xml to test_statepoint_restart.
2013-02-23 11:12:41 -05:00
docs Incremented version number to 0.5.1. 2013-02-22 10:37:05 -05:00
examples Updated examples with <eigenvalue> element. 2012-12-05 14:38:09 -05:00
man/man1 Added man page. 2012-12-01 10:48:57 -05:00
src Fixed error in reading state point in parallel. 2013-02-23 11:06:18 -05:00
tests Add tallies.xml to test_statepoint_restart. 2013-02-23 11:12:41 -05:00
.gitignore Add *.binary files to .gitignore. 2013-01-04 19:09:07 -05:00
cross_sections.xml Updated convert_xsdir.py to add alias. 2011-11-27 23:50:29 -05:00
cross_sections_ascii.xml Added cross_sections.xml for MCNP-distributed ASCII cross sections. 2013-02-08 21:49:39 -05:00
cross_sections_serpent.xml Introduced cross_sections.xml to replace use of xsdata. Closes gh-43. 2011-11-02 15:08:34 -04:00
LICENSE Update copyright year to 2013. 2013-01-29 21:51:23 -05:00
readme.rst Updated install instructions. 2012-12-05 10:53:04 -05:00
schemas.xml Added RELAX NG schema for cmfd.xml. 2012-10-13 16:04:16 -04: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. The project started under the
Computational Reactor Physics Group at MIT.

If you are interested in the project or would like to help and contribute,
please contact `Paul Romano`_.

---------------
Building OpenMC
---------------

Building the executable for OpenMC is as easy as going to the src directory and
running make. By default, the Makefile is set to use the GNU Fortran compiler,
gfortran. This can be changed by the F90 variable in the Makefile.

Compiling with support for distributed-memory parallelism can be controlled with
the MPI and MPI_DIR variables. The MPI_DIR variable should be set to the base
directory of the MPI implementation installed on your computer.

OpenMC has been tested on Linux, Mac, and Windows platforms with Intel, GNU,
IBM, Cray, and PGI compilers. It is recommended to use the latest version of
whatever compiler you should choose to use as there are a number of Fortran 2003
and 2008 intrinsics that are used in OpenMC.

--------------
Running OpenMC
--------------

To run OpenMC after building, you'll need to write an input file according to
the specifications in this documentation. With your input file complete, simply
run::

	openmc inputFile

where *inputFile* is the name of your input file. To run in parallel, use the
mpiexec or mpirun script provided by your MPI implementation. Assuming this is
on your PATH, you may run::

   mpiexec -n numProcs openmc inputFile

where *numProcs* is the number of processors you desire to run on.

.. _Paul Romano: mailto:paul.k.romano@gmail.com