crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-28 06:05:58 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Added building and running instructions on readme.rst.

Browse source
This commit is contained in:
Paul Romano 2011-07-24 15:20:02 -04:00
parent 5319f90bc7
commit a80510bc92
1 changed files with 32 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

34
readme.rst
View file

@ -1,5 +1,6 @@
OpenMC Monte Carlo Transport Code
=================================
==========================================
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
@ -8,4 +9,33 @@ 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.
--------------
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