Separated developer install instructions away from README.rst into docs.

这个提交包含在:
Craig Warren
2016-01-21 13:20:06 +00:00
父节点 334c2cf54a
当前提交 c34b6d4937
共有 2 个文件被更改,包括 83 次插入56 次删除

查看文件

@@ -12,16 +12,16 @@ gprMax is released under the GNU General Public License v3 or higher (http://www
gprMax is written in Python 3 (https://www.python.org) and includes performance-critical parts written in Cython/OpenMP (http://cython.org).
Using gprMax? Cite us.
----------------------
Using gprMax? Cite us
^^^^^^^^^^^^^^^^^^^^^
If you use gprMax and publish your work we would be grateful if you could cite gprMax using the following references:
* Warren, C., Giannopoulos, A., & Giannakis I. (2015). An advanced GPR modelling framework – the next generation of gprMax, In `Proc. 8th Int. Workshop Advanced Ground Penetrating Radar` (http://dx.doi.org/10.1109/IWAGPR.2015.7292621)
* Giannopoulos, A. (2005). Modelling ground penetrating radar by GprMax, `Construction and Building Materials`, 19(10), 755-762 (http://dx.doi.org/10.1016/j.conbuildmat.2005.06.007)
Software structure
==================
Package overview
================
.. code-block:: none
@@ -52,12 +52,11 @@ Software structure
Installation
============
You should use the following guidance to install gprMax:
You should use the following guidance to install gprMax if you are an end-user (i.e. you don't intend to develop or contribute to the software). Developers should follow the `Installation for developers section of the User guide <install-dev>`:
1. Get the code
2. Install Python and required Python packages
3. (*Developers only*) Install a C compiler which support OpenMP
4. (*Developers only*) Compile the Cython extensions
3. (*Microsoft Windows only*) Install C libraries
1. Get the code
---------------
@@ -68,8 +67,6 @@ You should use the following guidance to install gprMax:
* Download zip files of the *source code* and *binary extensions* for your platform, ``windows-32bit`` for 32-bit or ``windows-64bit`` for 64-bit versions of Microsoft Windows, ``linux-64bit`` for 64-bit versions of Linux, or ``macosx-64bit`` for 64-bit versions of Mac OS X.
* Expand both zip files and copy the contents of the ``windows-32bit``, ``windows-64bit``, ``linux-64bit`` or ``macosx-64bit`` directory into the ``gprMax-v.X.Y.Z/gprMax`` directory.
* (*Developers only*) Use **Git** (https://git-scm.com) and clone the master branch of the repository: :code:`git clone https://github.com/gprMax/gprMax.git`
2. Install Python and required Python packages
----------------------------------------------
@@ -84,54 +81,12 @@ We recommend using Miniconda to install Python and the required Python packages
.. note::
When you are finished using gprMax the Miniconda environment can be deactivated using (Linux/Mac OS X) :code:`source deactivate` or (Windows) :code:`deactivate`
(*Microsoft Windows only*) Install a C libraries
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3. (*Microsoft Windows only*) Install C libraries
-------------------------------------------------
* Install the Microsoft Visual Studio 2015 C++ Redistributable (``vc_redist.x86.exe`` for 32-bit or ``vc_redist.x64.exe`` for 64-bit) from https://www.microsoft.com/en-us/download/details.aspx?id=48145.
**You are now ready to proceed to the section on running gprMax.**
3. (*Developers only*) Install a C compiler which supports OpenMP
-------------------------------------------------------------------
Linux
^^^^^
* gcc (https://gcc.gnu.org) should be already installed, so no action is required.
Mac OS X
^^^^^^^^
* gcc (https://gcc.gnu.org) is easily installed using the Homebrew package manager (http://brew.sh) :code:`brew install gcc --without-multilib`.
.. note::
Installations of Xcode on Mac OS X come with the LLVM (clang) compiler, but it does not currently support OpenMP, so you must install gcc.
Microsoft Windows
^^^^^^^^^^^^^^^^^
* Download and install Microsoft Visual Studio 2015 Community (https://www.visualstudio.com/downloads/download-visual-studio-vs), which is free. Do a custom install and make sure under programming languages Visual C++ is selected, no other options are required.
* Create a new environment variable :code:`VS100COMNTOOLS` which matches the value of the existing :code:`VS140COMNTOOLS` environment variable. To set an environment variable from the Start Menu, right-click the Computer icon and select Properties. Click the Advanced System Settings link in the left column. In the System Properties window, click on the Advanced tab, then click the Environment Variables button near the bottom of that tab.
4. (*Developers only*) Compile the Cython extensions
------------------------------------------------------
Once you have installed the aforementioned tools follow these steps to build the Cython extension modules for gprMax:
a) Open a Terminal (Linux/Mac OS X) or Command Prompt (Windows) and navigate into the top-level gprMax directory.
b) Compile the Cython extension modules using: :code:`python setup.py build_ext --inplace`. You should see a set of :code:`.c` source files and a set of :code:`.so` (Linux/Mac OS X) or :code:`.pyd` (Windows) compiled module files inside the gprMax directory.
.. note::
If you want to remove/clean Cython generated files, e.g. before rebuilding the Cython extensions, you can use :code:`python setup.py cleanall`.
**(*Developers only*) You are now ready to proceed to the section on running gprMax.**
**You are now ready to proceed to running gprMax.**
Running gprMax
==============
@@ -144,7 +99,7 @@ Running gprMax
python -m gprMax path_to/name_of_input_file
For example to run one of the test models, navigate into the top-level gprMax directory and use:
For example to run one of the test models:
.. code-block:: none