From a80510bc92c1a20c787623aaa9872998e22a90ef Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Sun, 24 Jul 2011 15:20:02 -0400 Subject: [PATCH] Added building and running instructions on readme.rst. --- readme.rst | 34 ++++++++++++++++++++++++++++++++-- 1 file changed, 32 insertions(+), 2 deletions(-) diff --git a/readme.rst b/readme.rst index 941d3c4a55..4fb012a9a7 100644 --- a/readme.rst +++ b/readme.rst @@ -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