Changeset 9680 for trunk/anuga_core/INSTALL.rst
- Timestamp:
- Feb 18, 2015, 5:23:14 PM (9 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/anuga_core/INSTALL.rst
r9635 r9680 10 10 11 11 AnuGA is a python package with some C extensions (and an optional fortran 12 extension). At present AnuGA has not been transported to python 3.13 We recommend using python 2.7.12 extension). At present AnuGA has only been run and tested using python 2.x. 13 We recommend python 2.7. 14 14 15 15 If you have a python 2.7 environment with gcc and gfortran support, … … 18 18 19 19 20 Python Environment 21 ------------------ 20 Installing the dependencies 21 --------------------------- 22 22 23 A safe way to install AnuGA is to use a separate python environment 24 to isolate it from the rest of your system. Miniconda provides such 25 an environment. 23 AnuGA requires the following packages: 24 25 * `numpy <http://numpy.scipy.org/>`_ 26 * `scipy <http://scipy.org/>`_ 27 * `matplotlib <http://matplotlib.sourceforge.net/>`_ 28 * `gdal <http://gdal.org/>`_ 29 * `nose <http://nose.readthedocs.org/en/latest/>`_ 30 * A C compiler (preferably GCC or MinGW_ on Windows) 31 32 The easiest and **preferred** way to get all dependencies in the latest 33 version is using the Anaconda_ or the Miniconda_ Python 34 distributions by `Continuum Analytics`_. 35 Miniconda_ allows you to create multiple python environments and is particularly 36 useful if you want to keep multiple versions of AnuGA. 37 It does not require administrative rights to your computer and doesn't 38 interfere with the Python installed in your system. 39 For Windows users Anaconda_ even comes with MinGW_ so you don't have to worry about 40 the many, many, many issues of compiling under Windows. 26 41 27 42 43 Anaconda 44 ++++++++ 28 45 29 Easy Install 30 ------------ 46 Once you have downloaded and installed Anaconda_, 47 open a terminal (or ``cmd.exe`` on Windows) and run:: 31 48 32 Pip Install 33 ----------- 49 conda install pip nose numpy scipy netcdf4 matplotlib 50 conda install -c pingucarsti gdal 51 52 and setup GDAL_DATA environment variable: 34 53 35 Install from Source 54 export GDAL_DATA=`gdal-config --datadir` 55 56 57 Miniconda 58 +++++++++ 59 60 Once you have downloaded and installed Miniconda_, 61 open a terminal (or ``cmd.exe`` on Windows), create 62 a specific environment for AnuGA, by running:: 63 64 conda create -n anuga_env python=2.7 65 source activate anuga_env 66 67 conda install pip nose numpy scipy netcdf4 matplotlib 68 conda install -c pingucarsti gdal 69 70 and setup GDAL_DATA environment variable: 71 72 export GDAL_DATA=`gdal-config --datadir` 73 74 75 76 Extra dependencies for Windows users 77 ++++++++++++++++++++++++++++++++++++ 78 79 Unfortunately, the ``gcc`` compiler included in Anaconda MinGW_ 80 doesn't have OpenMP_ support. This is required to compile 81 some extension modules in AnuGA that have multi-threaded parallel code. 82 83 You'll have download and install TDM-GCC_ 84 **after** you've installed Anaconda and **before** you install AnuGA. 85 Don't forget to mark the ``openmp`` option in the "Choose Components" part of 86 the installation. See this `excellent documentation for Windows users`_ 87 (they even have screenshots!). 88 89 Installing AnuGA 90 ---------------- 91 92 After you've installed the dependencies you can proceed to install AnuGA 93 using pip_. 94 Open a terminal (or ``cmd.exe`` on Windows) and run:: 95 96 pip install anuga 97 98 and that's it! 99 100 If you already have AnuGA installed and want to **upgrade** to a newer 101 version, use:: 102 103 pip install anuga --upgrade 104 105 To uninstall simply run:: 106 107 pip uninstall anuga 108 109 110 .. note:: 111 112 The Windows installer from older versions is no longer supported. 113 114 Installing the latest development version 115 ----------------------------------------- 116 117 If you want the very latest code and features, 118 you can install AnuGA directly from Github_. 119 We try to maintain the *master* branch stable and 120 `passing all tests <https://travis-ci.org/stoiver/anuga_core/branches>`__, 121 so it should be safe to use. 122 123 First, you'll need to `install git`_. 124 Then, open a terminal and run:: 125 126 git clone --depth=50 --branch=master git://github.com/stoiver/anuga_core.git 127 128 This will fetch the source code from Github_ 129 and place it in a folder called ``anuga_core`` in the directory where you ran the 130 command. 131 Then, just ``cd`` into the directory and run ``pip``:: 132 133 cd anuga_core 134 pip install --upgrade . 135 136 Testing the install 36 137 ------------------- 37 138 139 140 From the source directory run ``python runtests.py`` 141 142 python runtests.py 143 144 145 If you get an error message or weird result, 146 please write to the `mailing list`_. 147 To make it easier for us to debug you problem, please include the following 148 information: 149 150 * Operating system 151 * Python distribution (Anaconda_, PythonXY_, `ETS/Canopy`_, own install) 152 * Python version (2.6, 2.7, 3.3, 3.4, etc) 153 * The script you ran (and gave you an error/weird result) 154 * The error message (the part that says ``Traceback: ...``) or result (figure, 155 numbers, etc) 156 157 158 .. _install git: http://git-scm.com/ 159 .. _Github: https://github.com/stoiver/anuga_core/ 160 .. _Python: http://www.python.org/ 161 .. _pip: http://www.pip-installer.org 162 .. _MinGW: http://www.mingw.org/ 163 .. _mailing list: anuga-user@lists.sourceforge.net 164 .. _Continuum Analytics: http://continuum.io/ 165 .. _Anaconda: http://continuum.io/downloads 166 .. _Miniconda: http://conda.pydata.org/miniconda.html 167 .. _PythonXY: http://code.google.com/p/pythonxy/ 168 .. _ETS/Canopy: http://code.enthought.com/projects/index.php 169 .. _OpenMP: http://openmp.org/ 170 .. _TDM-GCC: http://tdm-gcc.tdragon.net/ 171 .. _excellent documentation for Windows users: http://docs-windows.readthedocs.org/en/latest/devel.html#mingw-with-openmp-support 172
Note: See TracChangeset
for help on using the changeset viewer.