mirror of
https://github.com/openmc-dev/openmc.git
synced 2026-07-24 03:55:38 -04:00
116 lines
3.8 KiB
ReStructuredText
116 lines
3.8 KiB
ReStructuredText
.. _quickinstall:
|
|
|
|
===================
|
|
Quick Install Guide
|
|
===================
|
|
|
|
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.
|
|
|
|
----------------------------------------
|
|
Installing on Linux/Mac with conda-forge
|
|
----------------------------------------
|
|
|
|
`Conda <http://conda.pydata.org/docs/>`_ is an open source package management
|
|
system and environment management system for installing multiple versions of
|
|
software packages and their dependencies and switching easily between them. If
|
|
you have `conda` installed on your system, OpenMC can be installed via the
|
|
`conda-forge` channel. First, add the `conda-forge` channel with:
|
|
|
|
.. code-block:: sh
|
|
|
|
conda config --add channels conda-forge
|
|
|
|
OpenMC can then be installed with:
|
|
|
|
.. code-block:: sh
|
|
|
|
conda install openmc
|
|
|
|
--------------------------------
|
|
Installing on Ubuntu through PPA
|
|
--------------------------------
|
|
|
|
For users with Ubuntu 15.04 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
|
|
|
|
Binary packages from this PPA may exist for earlier versions of Ubuntu, but they
|
|
are no longer supported.
|
|
|
|
.. _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/
|
|
|
|
---------------------------------------
|
|
Installing from Source on Ubuntu 15.04+
|
|
---------------------------------------
|
|
|
|
To build OpenMC from source, several :ref:`prerequisites <prerequisites>` are
|
|
needed. If you are using Ubuntu 15.04 or higher, all prerequisites can be
|
|
installed directly from the package manager.
|
|
|
|
.. code-block:: sh
|
|
|
|
sudo apt-get install gfortran
|
|
sudo apt-get install cmake
|
|
sudo apt-get install libhdf5-dev
|
|
|
|
After the packages have been installed, follow the instructions below for
|
|
building and installing OpenMC from source.
|
|
|
|
.. note:: Before Ubuntu 15.04, the HDF5 package included in the Ubuntu Package
|
|
archive was not built with support for the Fortran 2003 HDF5
|
|
interface, which is needed by OpenMC. If you are using Ubuntu 14.10 or
|
|
before you will need to build HDF5 from source.
|
|
|
|
-------------------------------------------
|
|
Installing from Source on Linux or Mac OS X
|
|
-------------------------------------------
|
|
|
|
All OpenMC source code is hosted on GitHub_. If you have git_, the gfortran_
|
|
compiler, CMake_, and HDF5_ installed, you can download and install OpenMC be
|
|
entering the following commands in a terminal:
|
|
|
|
.. code-block:: sh
|
|
|
|
git clone https://github.com/mit-crpg/openmc.git
|
|
cd openmc
|
|
mkdir build && cd build
|
|
cmake ..
|
|
make
|
|
sudo make install
|
|
|
|
This will build an executable named ``openmc`` and install it (by default in
|
|
/usr/local/bin). If you do not have administrator privileges, the cmake command
|
|
should specify an installation directory where you have write access, e.g.
|
|
|
|
.. code-block:: sh
|
|
|
|
cmake -DCMAKE_INSTALL_PREFIX=$HOME/.local ..
|
|
|
|
If you want to build a parallel version of OpenMC (using OpenMP or MPI),
|
|
directions can be found in the :ref:`detailed installation instructions
|
|
<usersguide_build>`.
|
|
|
|
.. _GitHub: https://github.com/mit-crpg/openmc
|
|
.. _git: http://git-scm.com
|
|
.. _gfortran: http://gcc.gnu.org/wiki/GFortran
|
|
.. _CMake: http://www.cmake.org
|