From 54ad656d19f9047f6bb8dc1eeb8a2f998bd3fcc7 Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Wed, 9 Jan 2013 18:15:40 -0500 Subject: [PATCH] Updated Windows install instructions. --- docs/source/usersguide/install.rst | 61 +++++++++++++++++++++++++++--- 1 file changed, 55 insertions(+), 6 deletions(-) diff --git a/docs/source/usersguide/install.rst b/docs/source/usersguide/install.rst index 05f08e064..971c3bb01 100644 --- a/docs/source/usersguide/install.rst +++ b/docs/source/usersguide/install.rst @@ -126,11 +126,33 @@ 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: +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 +Cygwin`_. When you are asked to select packages, make sure the following are +selected: + +* Devel: gcc4-core +* Devel: gcc4-fortran +* Devel: make + +If you plan on obtaining the source code directly using git, select the +following packages: + +* Devel: git +* Devel: git-completion (Optional) +* Devel: gitk (Optional) + +In order to use the Python scripts provided with OpenMC, you will also need to +install Python. This can be done within Cygwin or directly in Windows. To +install within Cygwin, select the following packages: + +* Python: python (Version > 2.7 recommended) + +Once you have obtained the source code, run the following commands from within +the source code root directory: .. code-block:: sh @@ -139,7 +161,34 @@ root directory: This will build an executable named ``openmc``. -.. _Cygwin: http://www.cygwin.com/ +.. _Cygwin: http://cygwin.com/ +.. _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 +distribution is available on SourceForge_. When installing MinGW, make sure the +following components are selected: + +* MinGW Compiler Suite: Fortran Compiler +* MSYS Basic System + +Once MinGW is installed, copy the OpenMC source distribution to your MinGW home +directory (usually C:\\MinGW\\msys\\1.0\\home\\YourUsername). Once you have +the source code in place, run the following commands from within the MinGW shell +in the root directory of the OpenMC distribution: + +.. code-block:: sh + + cd src + make + +This will build an executable named ``openmc``. + +.. _MinGW: http://www.mingw.org +.. _SourceForge: http://sourceforge.net/projects/mingw --------------------------- Cross Section Configuration