Skip to content

Commit 26fe383

Browse files
author
Mark Wieczorek
committed
Additional uptdates to INSTALL documenation
1 parent a1ab9aa commit 26fe383

File tree

1 file changed

+47
-32
lines changed

1 file changed

+47
-32
lines changed

INSTALL

Lines changed: 47 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@ Installing Cartopy
44
Conda pre-built binaries
55
------------------------
66

7-
The easiest way to install Cartopy is through
8-
`Conda <https://conda.io/miniconda.html>`_. If conda is already installed, installation is as easy as::
7+
The easiest way to install Cartopy is by using
8+
`Conda <https://conda.io/miniconda.html>`_. If conda is already installed,
9+
installation is as easy as::
910

1011
conda install -c conda-forge cartopy
1112

@@ -23,92 +24,107 @@ Additional pre-built binaries can be found at a variety of sources, including:
2324
Building from source
2425
--------------------
2526

26-
Before building Cartopy from source, you need to **first** install the required dependencies listed below. Once these are installed, Cartopy can be installed using the pip installer::
27+
Before building Cartopy from source, you need to **first** install the
28+
required dependencies listed below. Once these are installed, Cartopy can be
29+
installed using the pip installer::
2730

2831
pip install cartopy
2932

30-
To instead install the most recent version found on the GitHub master branch, use::
33+
To instead install the most recent version found on the GitHub master branch,
34+
use::
3135

32-
pip install git+https://github.com/SciTools/cartopy.git --no-binary cartopy
36+
pip install git+https://github.com/SciTools/cartopy.git
3337

34-
Alternatively, you can clone the git repo on your computer and install using the `setup.py` file::
38+
Alternatively, you can clone the git repo on your computer and install manually
39+
using the `setup.py` file::
3540

3641
git clone https://github.com/SciTools/cartopy.git
3742
cd cartopy
38-
# Uncomment the following line to specify non-standard include and library paths
43+
# Uncomment the following to specify non-standard include and library paths
3944
# python setup.py build_ext -I/path/to/include -L/path/to/lib
4045
python setup.py install
4146

4247

4348
Required dependencies
4449
~~~~~~~~~~~~~~~~~~~~~
45-
In order to install Cartopy, or to access it's basic functionality, it will be necessary to first install **geos**, **numpy**, **cython**, **shapely**, **pyshp** and **six**. Many of these packages can be installed using pip or other package managers such as apt-get (linux) and brew (macos). Many of these dependencies are built as part of Cartopy's conda distribution, and the recipes for these can be found at https://github.com/conda-forge/feedstocks.
50+
In order to install Cartopy, or to access it's basic functionality, it will be
51+
necessary to first install **geos**, **numpy**, **cython**, **shapely**,
52+
**pyshp** and **six**. Many of these packages can be installed using pip or
53+
other package managers such as apt-get (linux) and brew (macos). Many of these
54+
dependencies are built as part of Cartopy's conda distribution, and the recipes
55+
for these packages can be found at https://github.com/conda-forge/feedstocks.
4656

4757
For macOS, the required dependencies can be installed in the following way::
4858

4959
brew install proj geos
5060
pip3 install --upgrade cython numpy pyshp six
51-
# shapely needs to be build from source. If it is already installed,
52-
# uninstall it by: pip3 uninstall shapely
61+
# shapely needs to be built from source to link to geos. If it is already
62+
# installed, uninstall it by: pip3 uninstall shapely
5363
pip3 install shapely --no-binary shapely
5464

55-
If you are installing dependencies with a package manager on Linux, you may need to install the development packages (look for a "-dev" suffix) in addition to the core packages.
65+
If you are installing dependencies with a package manager on Linux, you may
66+
need to install the development packages (look for a "-dev" suffix) in addition
67+
to the core packages.
5668

5769
Further information about the required dependencies can be found here:
5870

5971
**Python** 2.7 or later (https://www.python.org/)
60-
Cartopy requires Python 2.7 or later.
72+
6173
**Cython** 0.28 or later (https://pypi.python.org/pypi/Cython/)
6274

6375
**NumPy** 1.10 or later (https://numpy.org/)
6476
Python package for scientific computing including a powerful N-dimensional
6577
array object.
78+
6679
**GEOS** 3.3.3 or later (https://trac.osgeo.org/geos/)
67-
GEOS is an API of spatial predicates and functions for processing geometry
68-
written in C++.
80+
6981
**Shapely** 1.5.6 or later (https://github.com/Toblerity/Shapely)
70-
Python package for the manipulation and analysis of planar geometric
71-
objects.
82+
7283
**pyshp** 2.0 or later (https://pypi.python.org/pypi/pyshp)
73-
Pure Python read/write support for ESRI Shapefile format.
84+
7485
**PROJ** 4.9.0 or later (https://proj4.org/)
75-
Cartographic Projections library.
86+
7687
**six** 1.3.0 or later (https://pypi.python.org/pypi/six)
77-
Python 2 and 3 compatibility.
7888

7989

8090
Optional Dependencies
8191
~~~~~~~~~~~~~~~~~~~~~
82-
These are optional packages that you may want to install to enable
83-
additional Cartopy functionality.
92+
To make the most of Cartopy by enabling additional functionality, you may want
93+
to install these optional dependencies.
8494

8595
**Matplotlib** 1.5.1 or later (https://matplotlib.org/)
86-
Python package for 2D plotting. This package is required for any
87-
graphical capability.
96+
Python package required for any graphical capabilities.
8897

98+
<<<<<<< HEAD
8999
**GDAL** version 1.10.0 (https://gdal.org/)
90100
GDAL is a translator library for raster and vector geospatial data formats,
91101
which has powerful data transformation and processing capabilities.
102+
=======
103+
**GDAL** version 1.10.0 (http://www.gdal.org/)
104+
A translator library for raster and vector geospatial data formats
105+
that has powerful data transformation and processing capabilities.
106+
>>>>>>> Additional uptdates to INSTALL documenation
92107

93108
**Pillow** 1.7.8 or later (https://pypi.python.org/pypi/Pillow/2.3.0)
94-
Popular fork of PythonImagingLibrary.
109+
A popular fork of PythonImagingLibrary.
95110

96111
**pyepsg** 0.4.0 or later (https://github.com/rhattersley/pyepsg)
97112
A simple Python interface to https://epsg.io
98113

99114
**pykdtree** 1.2.2 or later (https://github.com/storpipfugl/pykdtree)
100-
Fast kd-tree implementation in Python; used for faster warping of images in
101-
preference to SciPy.
115+
A fast kd-tree implementation that is used for faster warping
116+
of images that in SciPy.
102117

103118
**SciPy** 0.10 or later (https://www.scipy.org/)
104-
Python package for scientific computing.
119+
A Python package for scientific computing.
105120

106121
**OWSLib** 0.8.7 (https://pypi.python.org/pypi/OWSLib)
107-
Python package for client programming with Open Geospatial Consortium
108-
(OGC) web service. Gives access to cartopy ogc clients.
122+
A Python package for client programming with the Open Geospatial
123+
Consortium (OGC) web service, and which gives access to cartopy ogc
124+
clients.
109125

110126
**Fiona** 1.0 or later (https://github.com/Toblerity/Fiona)
111-
Python package for reading shapefiles faster than the default (pyshp).
127+
A Python package for reading shapefiles that is faster than the pyshp.
112128

113129

114130
Testing Dependencies
@@ -119,8 +135,7 @@ These packages are required for the full Cartopy test suite to run.
119135
A platform independent file lock for Python.
120136

121137
**mock** 1.0.1 (https://pypi.python.org/pypi/mock/)
122-
Python mocking and patching package for testing. Note that this package
123-
is only required to support the Cartopy unit tests.
138+
Python mocking and patching package for testing.
124139

125140
**pytest** 3.1.0 or later (https://docs.pytest.org/en/latest/)
126141
Python package for software testing.

0 commit comments

Comments
 (0)