crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-26 21:25:36 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated install instructions.

Browse source
This commit is contained in:
Paul Romano 2012-12-05 10:53:04 -05:00
parent dd87f7ff68
commit 4c667befa7
2 changed files with 23 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

35
docs/source/usersguide/install.rst
View file

@ -9,8 +9,8 @@ Prerequisites
-------------
In order to compile OpenMC, you will need to have a Fortran compiler installed
on your machine. Since a number of Fortran 2003 features are used in the code,
it is recommended that you use the latest version of whatever compiler you
on your machine. Since a number of Fortran 2003/2008 features are used in the
code, it is recommended that you use the latest version of whatever compiler you
choose. For gfortran_, it is recommended that you use version 4.5.0 or above.
If you are using Debian or a Debian derivative such as Ubuntu, you can install
@ -21,9 +21,10 @@ the gfortran compiler using the following command::
To compile with support for parallel runs on a distributed-memory architecture,
you will need to have a valid implementation of MPI installed on your
machine. The code has been tested and is known to work with the latest versions
of both OpenMPI_ and MPICH2_. You may use older versions of MPI implementations
at your own risk. OpenMPI and/or MPICH2 can be installed on Debian derivatives
with::
of both OpenMPI_ and MPICH2_. Note that if using OpenMPI, make sure that
--with-mpi-f90-size is not set to medium or large since this may prevent MPI
calls from completing successfully in OpenMC. OpenMPI and/or MPICH2 can be
installed on Debian derivatives with::
sudo apt-get install mpich2
sudo apt-get install openmpi-bin
@ -75,7 +76,7 @@ Options sections in the Makefile:
COMPILER
This variable tells the Makefile which compiler to use. Valid options are
gfortran, intel, pgi, ibm, and cray.
gnu, intel, pgi, ibm, and cray. The default is gnu (gfortran).
DEBUG
Enables debugging when compiling. The flags added are dependent on which
@ -85,17 +86,21 @@ PROFILE
Enables profiling using the GNU profiler, gprof.
OPTIMIZE
Enables high-optimization using compiler-dependent flags. For gfortran,
this compiles with -O3. For Intel Fortran, this compiles with -O3 as well as
interprocedural optimization.
Enables high-optimization using compiler-dependent flags. For gfortran and
Intel Fortran, this compiles with -O3.
USE_MPI
Enables parallel runs using the Message Passing Interface. Users should also
set the MPI_ROOT directory further down in the Makefile.
MPI
Enables parallel runs using the Message Passing Interface. The MPI_DIR
variable should be set to the base directory of the MPI implementation.
USE_HDF5
Enables HDF5 output in addition to normal screen and text file output. Users
should also set the HDF5_ROOT directory further down in the Makefile.
HDF5
Enables HDF5 output in addition to normal screen and text file output. The
HDF5_DIR variable should be set to the base directory of the HDF5
installation.
PETSC
Enables PETSc for use in CMFD acceleration. The PETSC_DIR variable should be
set to the base directory of the PETSc installation.
It is also possible to change these options from the command line itself. For
example, if you want to compile with DEBUG turned on without actually change the

6
readme.rst
View file

@ -17,9 +17,9 @@ 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 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.
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