你已经派生过 gprMax
镜像自地址
https://gitee.com/sunhf/gprMax.git
已同步 2025-08-07 15:10:13 +08:00
78 行
3.8 KiB
ReStructuredText
78 行
3.8 KiB
ReStructuredText
.. include:: ../../README.rst
|
|
|
|
.. _install-dev:
|
|
|
|
Installation for developers
|
|
===========================
|
|
|
|
Those that are interested in developing or contributing to gprMax should use the following installation guidance:
|
|
|
|
1. Get the code
|
|
2. Install Python and required Python packages
|
|
3. Install a C compiler which supports OpenMP
|
|
4. Compile the Cython extensions and install packages
|
|
|
|
1. Get the code
|
|
---------------
|
|
|
|
* 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
|
|
----------------------------------------------
|
|
|
|
We recommend using Miniconda to install Python and the required Python packages for gprMax in a self-contained Python environment. Miniconda is a mini version of Anaconda which is a completely free Python distribution (including for commercial use and redistribution). It includes more than 300 of the most popular Python packages for science, math, engineering, and data analysis.
|
|
|
|
* Install the Python 3.5 version of Miniconda for your platform from http://conda.pydata.org/miniconda.html (You can get help with installing Miniconda from http://conda.pydata.org/docs/install/quick.html)
|
|
* Open a Terminal (Linux/Mac OS X) or Command Prompt (Windows) and navigate into the top-level gprMax directory.
|
|
* Update conda :code:`conda update conda`
|
|
* Create an environment (using the supplied ``conda_env.yml`` environment file) for gprMax with all the necessary Python packages :code:`conda env create -f conda_env.yml`
|
|
* Activate the new environment :code:`source activate gprMax` (Linux/Mac OS X) or :code:`activate gprMax` (Windows).
|
|
|
|
.. note::
|
|
* When you are finished using gprMax the Miniconda environment can be deactivated using :code:`source deactivate` (Linux/Mac OS X) or :code:`deactivate` (Windows).
|
|
* If you want to install Python and the required Python packages manually, i.e. without using Anaconda/Miniconda, look in the ``conda_env.yml`` file for a list of the requirements.
|
|
|
|
|
|
3. 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 'Programming languages|Visual C++|Common Tools for Visual C++ 2015' is selected, no other options are required.
|
|
|
|
.. figure:: images/MSVS2015_install.png
|
|
:width: 400 px
|
|
|
|
Screenshot of Microsoft Visual Studio 2015 Community custom install settings.
|
|
|
|
|
|
4. Compile the Cython extensions and install packages
|
|
-----------------------------------------------------
|
|
|
|
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 and install using: :code:`python setup.py install`. 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`.
|
|
|
|
**You are now ready to proceed to running gprMax.** |