forked from SciTools/iris
-
Notifications
You must be signed in to change notification settings - Fork 0
/
INSTALL
209 lines (147 loc) · 7.22 KB
/
INSTALL
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
You can either install Iris using the conda package manager or from source.
Installing using conda
----------------------
Iris is available using conda for the following platforms:
* Linux 64-bit,
* Mac OSX 64-bit, and
* Windows 32-bit and 64-bit.
To install Iris using conda, you must first download and install conda,
for example from http://conda.pydata.org/miniconda.html.
Once conda is installed, you can install Iris using conda on any platform with
the following command::
conda install -c conda-forge iris
If you wish to run any of the code examples
(see http://scitools.org.uk/iris/docs/latest/examples/index.html) you will also
need the Iris sample data. This can also be installed using conda::
conda install -c conda-forge iris-sample-data
Further documentation on using conda and the features it provides can be found
at http://conda.pydata.org/docs/intro.html.
Installing from source
----------------------
The latest Iris source release is available from
https://github.com/SciTools/iris.
Iris makes use of a range of other libraries and python modules. These
dependencies must be in place before you can successfully install
Iris. Once you have satisfied the requirements detailed below,
extract the iris source package, cd to the new directory, and enter::
python setup.py install
In-place build - an alternative for developers
==============================================
We strongly encourage people to contribute to Iris and for this type of
development activity an in-place build can be useful. Once you've cloned
the Iris git repository you can perform an in-place build by entering::
python setup.py std_names
python setup.py build_ext --inplace
Details of other setup.py options and commands can be found by entering::
python setup.py --help
and::
python setup.py --help-commands
Build and runtime requirements
==============================
These are external packages which you will need to have installed before
installing and running Iris.
Many of these packages are available in Linux package managers
such as aptitude and yum. For example, it may be possible to install
Numpy using::
apt-get install python-numpy
If you are installing dependencies with a package manager on Linux,
you may need to install the development packages (look for a "-dev"
postfix) in addition to the core packages.
python 2.7 or 3.4 (http://www.python.org/)
Iris requires Python 2.7 or Python 3.4.
numpy 1.9 or later (http://numpy.scipy.org/)
Python package for scientific computing including a powerful N-dimensional
array object.
biggus 0.14 or later (https://github.com/SciTools/biggus)
Virtual large arrays and lazy evaluation.
scipy 0.10 or later (http://www.scipy.org/)
Python package for scientific computing.
cartopy 0.11.0 or later (http://github.com/SciTools/cartopy/)
Python package which provides cartographic tools for python.
PyKE 1.1.1 or later (http://pyke.sourceforge.net/)
Python knowledge-based inference engine.
netcdf4-python 0.9.9 or later (http://netcdf4-python.googlecode.com/)
Python interface to the netCDF version 4 C library.
(It is strongly recommended to ensure your installation uses a
thread-safe build of HDF5 to avoid segmentation faults when using
lazy evaluation.)
cf_units 1.0 or later (https://github.com/SciTools/cf_units)
CF data units handling, using udunits (q.v.).
udunits2 2.1.24 or later
(http://www.unidata.ucar.edu/downloads/udunits/index.jsp)
C library for units of physical quantities.
setuptools 0.6c11 or later (http://pypi.python.org/pypi/setuptools/)
Python package for installing/removing python packages.
Optional
''''''''
These are optional packages which you may want to install to enable
additonal Iris functionality such as plotting and
loading/saving GRIB. These packages are required for the full Iris test
suite to run.
gdal 1.9.1 or later (https://pypi.python.org/pypi/GDAL/)
Python package for the Geospatial Data Abstraction Library (GDAL).
graphviz 2.18 or later (http://www.graphviz.org/)
Graph visualisation software.
grib-api 1.9.16 or later
(https://software.ecmwf.int/wiki/display/GRIB/Releases)
API for the encoding and decoding WMO FM-92 GRIB edition 1 and
edition 2 messages. A compression library such as Jasper is required
to read JPEG2000 compressed GRIB2 files.
iris-grib 0.9 or later
(https://github.com/scitools/iris-grib)
Iris interface to ECMWF's GRIB API
matplotlib 1.2.0 (http://matplotlib.sourceforge.net/)
Python package for 2D plotting.
mock 1.0.1 (http://pypi.python.org/pypi/mock/)
Python mocking and patching package for testing. Note that this package
is only required to support the Iris unit tests.
nose 1.1.2 or later (https://nose.readthedocs.io/en/latest/)
Python package for software testing. Iris is not compatible with nose2.
pep8 1.4.6 (https://pypi.python.org/pypi/pep8)
Python package for software testing.
pandas 0.11.0 or later (http://pandas.pydata.org)
Python package providing high-performance, easy-to-use data structures and
data analysis tools.
PythonImagingLibrary 1.1.7 or later (http://effbot.org/zone/pil-index.htm)
Python package for image processing.
pyugrid 0.1.1 or later (https://github.com/pyugrid/pyugrid)
A Python API to utilize data written using the unstructured grid
UGRID conventions.
shapely 1.2.14 (https://github.com/Toblerity/Shapely)
Python package for the manipulation and analysis of planar geometric
objects.
mo_pack 0.1.0dev0 (https://github.com/SciTools/mo_pack)
A Python wrapper to libmo_unpack, giving WGDOS packing and unpacking.
* Those packages have been tested with a specific build.
Packed PP
=========
The libmo_unpack library can be used by Iris for decoding/unpacking
PP files or Fields files that use an lbpack value of 1 or 4. This
library is open source, licensed under the 2-clause BSD licence.
It can be obtained from http://puma.nerc.ac.uk/trac/UM_TOOLS/wiki/unpack.
Use of this library is not enabled by default. If this library is
available its use can be enabled by installing Iris with the following
command::
python setup.py --with-unpack install
Note that if this library and/or its associated header files are installed
in a custom location then additional compiler arguments may need to be
passed in to ensure that the Python extension module linking against it
builds correctly::
python setup.py --with-unpack build_ext -I <custom include dir> \
-L <custom link-time libdir> -R <custom runtime libdir> install
Custom site configuration
=========================
The default site configuration values can be overridden by creating the file
``iris/etc/site.cfg``. For example, the following snippet can be used to
specify a non-standard location for your udunits library::
[System]
udunits2_path = /path/to/libudunits2.so
An example configuration file is available in ``iris/etc/site.cfg.template``.
See :py:func:`iris.config` for further configuration options.
Packaged distributions
======================
The Enthought Python Distribution (EPD)
http://www.enthought.com/products/epd.php for Windows, OS X or
Redhat provides some of the dependencies for Iris as does Python (x, y)
https://python-xy.github.io/ which tends to be updated a
bit more frequently.