crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-24 12:05:32 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
OpenMC Monte Carlo Code https://docs.openmc.org
422 commits 16 branches 33 tags 281 MiB
Find a file
Paul Romano 8fc482a2a4 Updated documentation.
2012-02-08 13:43:41 -05:00
docs Updated documentation. 2012-02-08 13:43:41 -05:00
examples Updated lattice example with simple and nested versions. 2011-12-02 03:44:38 -05:00
presentations/crpg_2011-10-06 Many additions to CRPG presentations. 2011-10-03 23:49:21 -04:00
src Substantially changed logic for fission bank algorithm to improve performance and handle multiple messages. 2012-02-07 14:37:16 -05:00
.gitignore Added Python plotting script for plot.out files. 2011-10-16 23:17:41 -04:00
ChangeLog Read URR data, log file creation. 2011-06-24 11:02:10 -04:00
cross_sections.xml Updated convert_xsdir.py to add alias. 2011-11-27 23:50:29 -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 Initial commit with some basic geometry and IO routines. 2011-01-17 23:52:55 +00:00
readme.rst Comment on different compilers in readme.rst. 2011-07-25 21:06:58 -04: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 Intel Fortran compiler,
ifort. This can be changed by the F90 variable in the Makefile.

Compiling for multiple processors can be controlled with the USE_MPI and MPI
variables. The MPI variable should be set to the base directory of the MPI
implementation installed on your computer.

OpenMC has been tested on Linux platforms with Intel, GNU, PGI, and Cray
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. While no testing has been done on Mac or Windows
platforms, there is no reason to believe it should not compile on any platform.

--------------
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:romano7@gmail.com