From 3c2878b6cfe3cedd2b98113c367b140c0b922dfd Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Sat, 19 May 2012 22:23:55 +0700 Subject: [PATCH] Modified install guides in documentation. --- docs/source/index.rst | 2 +- docs/source/install.rst | 109 ------------------ docs/source/methods/index.rst | 4 - docs/source/quickinstall.rst | 72 ++++++++++++ docs/source/releasenotes/notes_0.4.2.rst | 7 +- docs/source/usersguide/index.rst | 2 +- .../usersguide/{setup.rst => install.rst} | 9 +- 7 files changed, 83 insertions(+), 122 deletions(-) delete mode 100644 docs/source/install.rst create mode 100644 docs/source/quickinstall.rst rename docs/source/usersguide/{setup.rst => install.rst} (96%) diff --git a/docs/source/index.rst b/docs/source/index.rst index eb9775b77..da41dcd97 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -23,7 +23,7 @@ Contents .. toctree:: :maxdepth: 1 - install + quickinstall releasenotes/index methods/index usersguide/index diff --git a/docs/source/install.rst b/docs/source/install.rst deleted file mode 100644 index 07a6503eb..000000000 --- a/docs/source/install.rst +++ /dev/null @@ -1,109 +0,0 @@ -.. _install: - -============ -Installation -============ - --------------------- -Obtaining the Source --------------------- - -All OpenMC source code is hosted on GitHub_. This means that you will need to -have git_ installed on your computer in order to get source code and updates -directly from the repository. GitHub has a good set of `instructions -`_ for how to set up git to work -with GitHub since this involves setting up ssh_ keys. With git installed and -setup, the following command will download the full source code from the GitHub -repository:: - - git clone git@github.com:mit-crpg/openmc.git - -.. _GitHub: http://github.com -.. _git: http://git-scm.com -.. _ssh: http://en.wikipedia.org/wiki/Secure_Shell - -------------- -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 -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 -the gfortran compiler using the following command:: - - sudo apt-get install gfortran - -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:: - - sudo apt-get install mpich2 - sudo apt-get install openmpi-bin - -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. - -.. _gfortran: http://gcc.gnu.org/wiki/GFortran -.. _OpenMPI: http://www.open-mpi.org -.. _MPICH2: http://www.mcs.anl.gov/mpi/mpich/ -.. _HDF5: http://www.hdfgroup.org/HDF5/ - -------------- -Configuration -------------- - -All configuration for OpenMC is done within the Makefile located in -``src/Makefile``. In the Makefile, you will see that there are a number of User -Options which can be changed. It is recommended that you do not change anything -else in the Makefile unless you are experienced with compiling and building -software using Makefiles. The following parameters can be set from the User -Options sections in the Makefile: - -COMPILER - This variable tells the Makefile which compiler to use. Valid options are - gfortran, intel, and pgi. - -DEBUG - Enables debugging when compiling. The flags added are dependent on which - compiler is used. - -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. - -USE_MPI - Enables parallel runs using the Message Passing Interface. Users should also - set the MPI_ROOT directory further down in the Makefile. - -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. - -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 -Makefile, you can enter the following from a terminal:: - - make DEBUG=yes - ---------- -Compiling ---------- - -To compile the code, run the following commands from within the root directory -for OpenMC:: - - cd openmc/src - make - -This will build an executable named ``openmc``. diff --git a/docs/source/methods/index.rst b/docs/source/methods/index.rst index bc0810242..08cba68d2 100644 --- a/docs/source/methods/index.rst +++ b/docs/source/methods/index.rst @@ -4,10 +4,6 @@ Theory and Methodology ====================== -The OpenMC code solves the neutron transport equation using the Monte Carlo -method whereby particles are tracked as they randomly move through a geometry, -undergoing collisions, and creating secondary particles. - .. toctree:: :numbered: :maxdepth: 2 diff --git a/docs/source/quickinstall.rst b/docs/source/quickinstall.rst new file mode 100644 index 000000000..ac1ed52d6 --- /dev/null +++ b/docs/source/quickinstall.rst @@ -0,0 +1,72 @@ +.. _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. + +------------- +Prerequisites +------------- + +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 improved output format (*optional*) + +.. _gfortran: http://gcc.gnu.org/wiki/GFortran +.. _git: http://git-scm.com +.. _HDF5: http://www.hdfgroup.org/HDF5/ + +-------------------- +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: + +.. code-block:: sh + + cd src + make + +This will build an executable named ``openmc``. + +-------------------- +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/ diff --git a/docs/source/releasenotes/notes_0.4.2.rst b/docs/source/releasenotes/notes_0.4.2.rst index f213581c4..70923cfdd 100644 --- a/docs/source/releasenotes/notes_0.4.2.rst +++ b/docs/source/releasenotes/notes_0.4.2.rst @@ -13,10 +13,9 @@ System Requirements ------------------- There are no special requirements for running the OpenMC code. As of this -release, OpenMC has been tested on a variety of Linux distributions as well as -Mac OS X. However, it has not been tested yet on any versions of Microsoft -Windows. Memory requirements will vary depending on the size of the problem at -hand (mostly on the number of nuclides in the problem). +release, OpenMC has been tested on a variety of Linux distributions, Mac OS X, +and Microsoft Windows 7. Memory requirements will vary depending on the size of +the problem at hand (mostly on the number of nuclides in the problem). ------------ New Features diff --git a/docs/source/usersguide/index.rst b/docs/source/usersguide/index.rst index 0f1d5da34..a3b158365 100644 --- a/docs/source/usersguide/index.rst +++ b/docs/source/usersguide/index.rst @@ -12,6 +12,6 @@ essential aspects of using OpenMC to perform neutronic simulations. :maxdepth: 3 beginners - setup + install input troubleshoot diff --git a/docs/source/usersguide/setup.rst b/docs/source/usersguide/install.rst similarity index 96% rename from docs/source/usersguide/setup.rst rename to docs/source/usersguide/install.rst index b49eb08d4..98196e814 100644 --- a/docs/source/usersguide/setup.rst +++ b/docs/source/usersguide/install.rst @@ -1,4 +1,4 @@ -.. _usersguide_setup: +.. _usersguide_install: ============================== Installation and Configuration @@ -53,7 +53,7 @@ repository:: git clone git@github.com:mit-crpg/openmc.git -.. _GitHub: http://github.com +.. _GitHub: https://github.com/mit-crpg/openmc .. _git: http://git-scm.com .. _ssh: http://en.wikipedia.org/wiki/Secure_Shell @@ -137,7 +137,7 @@ Cross-Section Configuration In order to run a simulation with OpenMC, you will need cross-section data for each nuclide in your problem. Since OpenMC uses ACE format cross-sections, you -can use nuclear data distributed with MCNP or Serpent. +can use nuclear data distributed with MCNP_ or Serpent_. To use cross sections distributed with MCNP, change the element in the ``cross_sections.xml`` file in the root directory of the OpenMC distribution @@ -152,6 +152,9 @@ cross-sections. Then, either set the :ref:`cross_sections` in a settings.xml file or the :envvar:`CROSS_SECTIONS` environment variable to the absolute path of the ``cross_sections_serpent.xml`` file. +.. _MCNP: https://laws.lanl.gov/vhosts/mcnp.lanl.gov/ +.. _Serpent: http://montecarlo.vtt.fi + -------------- Running OpenMC --------------