mirror of
https://github.com/openmc-dev/openmc.git
synced 2026-07-29 06:35:48 -04:00
Updated installation documentation with PPA description.
This commit is contained in:
Paul Romano
parent
780f051dcc
commit
ac67d8e041
2 changed files with 103 additions and 85 deletions
|
|
@ -8,69 +8,47 @@ This quick install guide outlines the basic steps needed to install OpenMC on
|
|||
your computer. For more detailed instructions on configuring and installing
|
||||
OpenMC, see :ref:`usersguide_install` in the User's Manual.
|
||||
|
||||
-------------
|
||||
Prerequisites
|
||||
-------------
|
||||
--------------------------------
|
||||
Installing on Ubuntu through PPA
|
||||
--------------------------------
|
||||
|
||||
In order to compile and run OpenMC, a number of prerequisite software packages
|
||||
and libraries may be needed. These include:
|
||||
|
||||
- A Fortran compiler such as gfortran_
|
||||
- git_ version control software for obtaining source code (*optional*)
|
||||
- An MPI implementation for parallel runs (*optional*)
|
||||
- HDF5_ Library for portable binary output format (*optional*)
|
||||
- PETSc_ for CMFD acceleration (*optional*)
|
||||
|
||||
.. _gfortran: http://gcc.gnu.org/wiki/GFortran
|
||||
.. _git: http://git-scm.com
|
||||
.. _HDF5: http://www.hdfgroup.org/HDF5/
|
||||
.. _PETSc: http://www.mcs.anl.gov/petsc/
|
||||
|
||||
--------------------
|
||||
Obtaining the Source
|
||||
--------------------
|
||||
|
||||
All OpenMC source code is hosted on GitHub_. The latest version of the OpenMC
|
||||
source code can be downloaded from GitHub with the following command::
|
||||
|
||||
git clone git@github.com:mit-crpg/openmc.git
|
||||
|
||||
If you don't have git installed, you can download the source as a zip or tar
|
||||
file directly from GitHub.
|
||||
|
||||
.. _GitHub: https://github.com/mit-crpg/openmc
|
||||
|
||||
-------------------------------
|
||||
Compiling on Linux and Mac OS X
|
||||
-------------------------------
|
||||
|
||||
To compile OpenMC on Linux or Max OS X, run the following commands from within
|
||||
the root directory of the source code:
|
||||
For users with Ubuntu 11.10 or later, a binary package for OpenMC is available
|
||||
through a `Personal Package Archive`_ (PPA) and can be installed through the `APT
|
||||
package manager`_. Simply enter the following commands into the terminal:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
cd src
|
||||
sudo apt-add-repository ppa:paulromano/staging
|
||||
sudo apt-get update
|
||||
sudo apt-get install openmc
|
||||
|
||||
Currently, the binary package does not allow for parallel simulations, HDF5_, or
|
||||
CMFD acceleration through PETSc_. Users who need such capabilities should build
|
||||
OpenMC from source as is described in :ref:`usersguide_install`.
|
||||
|
||||
.. _Personal Package Archive: https://launchpad.net/~paulromano/+archive/staging
|
||||
.. _APT package manager: https://help.ubuntu.com/community/AptGet/Howto
|
||||
.. _HDF5: http://www.hdfgroup.org/HDF5/
|
||||
.. _PETSc: http://www.mcs.anl.gov/petsc/
|
||||
|
||||
-------------------------------------------
|
||||
Installing from Source on Linux or Mac OS X
|
||||
-------------------------------------------
|
||||
|
||||
All OpenMC source code is hosted on GitHub_. If you have git_ and the gfortran_
|
||||
compiler installed, you can download and install OpenMC be entering the
|
||||
following commands in a terminal:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
git clone git@github.com:mit-crpg/openmc.git
|
||||
cd openmc/src
|
||||
make
|
||||
sudo make install
|
||||
|
||||
This will build an executable named ``openmc`` and install it (by default in
|
||||
/usr/local/bin).
|
||||
|
||||
--------------------
|
||||
Compiling on Windows
|
||||
--------------------
|
||||
|
||||
To compile OpenMC on a Windows operating system, you will need to first install
|
||||
Cygwin_, a Linux-like environment for Windows. When configuring Cygwin, make
|
||||
sure you install both the gfortran compiler as well as git. Once you have
|
||||
obtained the source code, run the following commands from within the source code
|
||||
root directory:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
cd src
|
||||
make
|
||||
|
||||
This will build an executable named ``openmc``.
|
||||
|
||||
.. _Cygwin: http://www.cygwin.com/
|
||||
.. _GitHub: https://github.com/mit-crpg/openmc
|
||||
.. _git: http://git-scm.com
|
||||
.. _gfortran: http://gcc.gnu.org/wiki/GFortran
|
||||
|
|
|
|||
|
|
@ -4,38 +4,82 @@
|
|||
Installation and Configuration
|
||||
==============================
|
||||
|
||||
-------------
|
||||
-----------------------------
|
||||
Installing on Ubuntu with PPA
|
||||
-----------------------------
|
||||
|
||||
For users with Ubuntu 11.10 or later, a binary package for OpenMC is available
|
||||
through a Personal Package Archive (PPA) and can be installed through the APT
|
||||
package manager. First, add the following PPA to the repository sources:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
sudo apt-add-repository ppa:paulromano/staging
|
||||
|
||||
Next, resynchronize the package index files:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
sudo apt-get update
|
||||
|
||||
Now OpenMC should be recognized within the repository and can be installed:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
sudo apt-get install openmc
|
||||
|
||||
--------------------
|
||||
Building from Source
|
||||
--------------------
|
||||
|
||||
Prerequisites
|
||||
-------------
|
||||
|
||||
In order to compile OpenMC, you will need to have a Fortran compiler installed
|
||||
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 necessary to use version 4.6.0 or above.
|
||||
.. admonition:: Required
|
||||
|
||||
If you are using Debian or a Debian derivative such as Ubuntu, you can install
|
||||
the gfortran compiler using the following command::
|
||||
* A Fortran compiler such as gfortran_
|
||||
|
||||
sudo apt-get install gfortran
|
||||
In order to compile OpenMC, you will need to have a Fortran compiler
|
||||
installed 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 necessary to use
|
||||
version 4.6.0 or above.
|
||||
|
||||
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_. 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::
|
||||
If you are using Debian or a Debian derivative such as Ubuntu, you can
|
||||
install the gfortran compiler using the following command::
|
||||
|
||||
sudo apt-get install mpich2
|
||||
sudo apt-get install openmpi-bin
|
||||
sudo apt-get install gfortran
|
||||
|
||||
To compile with support for HDF5_ output (highly recommended), you will need to
|
||||
have HDF5 installed on your computer. The installed version will need to have
|
||||
been compiled with the same compiler you intend to compile OpenMC with.
|
||||
.. admonition:: Optional
|
||||
|
||||
To enable CMFD acceleration, you will need to have PETSc_ installed on your
|
||||
computer. The installed version will need to have been compiled with the same
|
||||
compiler you intend to compile OpenMC with.
|
||||
* An MPI implementation for distributed-memory parallel runs
|
||||
|
||||
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_. 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
|
||||
|
||||
* HDF5_ Library for portable binary output format
|
||||
|
||||
To compile with support for HDF5_ output (highly recommended), you will
|
||||
need to have HDF5 installed on your computer. The installed version will
|
||||
need to have been compiled with the same compiler you intend to compile
|
||||
OpenMC with.
|
||||
|
||||
* PETSc_ for CMFD acceleration
|
||||
|
||||
To enable CMFD acceleration, you will need to have PETSc_ installed on
|
||||
your computer. The installed version will need to have been compiled with
|
||||
the same compiler you intend to compile OpenMC with.
|
||||
|
||||
* git_ version control software for obtaining source code
|
||||
|
||||
.. _gfortran: http://gcc.gnu.org/wiki/GFortran
|
||||
.. _OpenMPI: http://www.open-mpi.org
|
||||
|
|
@ -43,7 +87,6 @@ compiler you intend to compile OpenMC with.
|
|||
.. _HDF5: http://www.hdfgroup.org/HDF5/
|
||||
.. _PETSc: http://www.mcs.anl.gov/petsc/
|
||||
|
||||
--------------------
|
||||
Obtaining the Source
|
||||
--------------------
|
||||
|
||||
|
|
@ -63,7 +106,6 @@ repository::
|
|||
.. _git: http://git-scm.com
|
||||
.. _ssh: http://en.wikipedia.org/wiki/Secure_Shell
|
||||
|
||||
-------------------
|
||||
Build Configuration
|
||||
-------------------
|
||||
|
||||
|
|
@ -108,7 +150,6 @@ Makefile, you can enter the following from a terminal::
|
|||
|
||||
make DEBUG=yes
|
||||
|
||||
-------------------------------
|
||||
Compiling on Linux and Mac OS X
|
||||
-------------------------------
|
||||
|
||||
|
|
@ -124,12 +165,11 @@ the root directory of the source code:
|
|||
This will build an executable named ``openmc`` and install it (by default in
|
||||
/usr/local/bin).
|
||||
|
||||
--------------------
|
||||
Compiling on Windows
|
||||
--------------------
|
||||
|
||||
Using Cygwin
|
||||
------------
|
||||
++++++++++++
|
||||
|
||||
One option for compiling OpenMC on a Windows operating system is to use Cygwin_,
|
||||
a Linux-like environment for Windows. You will need to first `install
|
||||
|
|
@ -167,7 +207,7 @@ This will build an executable named ``openmc``.
|
|||
.. _install Cygwin: http://cygwin.com/setup.exe
|
||||
|
||||
Using MinGW
|
||||
-----------
|
||||
+++++++++++
|
||||
|
||||
An alternate option for installing OpenMC on Windows is using MinGW_, which
|
||||
stands for Minimalist GNU for Windows. An executable for installing the MinGW
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue