From d4d86fb98cbe4ed34546cb4eb1b88418a707dd82 Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Tue, 19 Jan 2016 12:56:42 -0600 Subject: [PATCH 1/2] Update quick install instructions --- docs/source/quickinstall.rst | 44 +++++++++++++++++++++++++----- docs/source/usersguide/install.rst | 9 ++++-- 2 files changed, 44 insertions(+), 9 deletions(-) diff --git a/docs/source/quickinstall.rst b/docs/source/quickinstall.rst index 9ce752be7c..8bf95e245f 100644 --- a/docs/source/quickinstall.rst +++ b/docs/source/quickinstall.rst @@ -12,24 +12,55 @@ OpenMC, see :ref:`usersguide_install` in the User's Manual. Installing on Ubuntu through 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`_. Simply enter the following commands into the terminal: +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 -Currently, the binary package does not allow for parallel simulations or use of -HDF5_. Users who need such capabilities should build OpenMC from source as is -described in :ref:`usersguide_install`. +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 ` are +needed. If you are 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 ------------------------------------------- @@ -42,7 +73,6 @@ entering the following commands in a terminal: git clone https://github.com/mit-crpg/openmc.git cd openmc - git checkout -b master origin/master mkdir build && cd build cmake .. make diff --git a/docs/source/usersguide/install.rst b/docs/source/usersguide/install.rst index e3f0df5e91..4075e03033 100644 --- a/docs/source/usersguide/install.rst +++ b/docs/source/usersguide/install.rst @@ -9,8 +9,8 @@ Installing on Ubuntu with 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: +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 @@ -31,10 +31,15 @@ Now OpenMC should be recognized within the repository and can be installed: 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 + -------------------- Building from Source -------------------- +.. _prerequisites: + Prerequisites ------------- From 918c1bf45991cc8dd4b10dbada78a6aa472f8bd9 Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Tue, 19 Jan 2016 13:41:50 -0600 Subject: [PATCH 2/2] Fix typo. I am not Ubuntu. --- docs/source/quickinstall.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/quickinstall.rst b/docs/source/quickinstall.rst index 8bf95e245f..7faa4978dd 100644 --- a/docs/source/quickinstall.rst +++ b/docs/source/quickinstall.rst @@ -44,8 +44,8 @@ Installing from Source on Ubuntu 15.04+ --------------------------------------- To build OpenMC from source, several :ref:`prerequisites ` are -needed. If you are Ubuntu 15.04 or higher, all prerequisites can be installed -directly from the package manager. +needed. If you are using Ubuntu 15.04 or higher, all prerequisites can be +installed directly from the package manager. .. code-block:: sh