Skip to content

Commit 45b9c3c

Browse files
committed
Update main README
1 parent 2d829c1 commit 45b9c3c

File tree

1 file changed

+30
-29
lines changed

1 file changed

+30
-29
lines changed

README.md

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,20 @@ using matplotlib.
1111
Basic requirements are the following:
1212

1313
* Python 2.6 (or higher)
14-
* matplotlib
15-
* numpy
14+
* [matplotlib](https://github.com/matplotlib/matplotlib)
15+
* [numpy](https://github.com/numpy/numpy)
1616
* [pyproj](https://github.com/pyproj4/pyproj)
1717
* [pyshp](https://github.com/GeospatialPython/pyshp)
18-
* GEOS library (Geometry Engine, Open Source) version 3.1.1 or higher.
19-
* On Linux, if your Python was installed via a package management
20-
system, make sure the corresponding `python-dev` package is also
21-
installed. Otherwise, you may not have the Python header (`Python.h`),
22-
which is required to build Python C extensions.
18+
* [six](https://github.com/benjaminp/six)
2319

2420
Optional requirements include:
2521

2622
* [OWSLib](https://github.com/geopython/OWSLib). It is needed for the
27-
`BaseMap.wmsimage` function.
23+
`Basemap.wmsimage` function.
2824

29-
* [Pillow](https://python-pillow.github.io/). It is needed for Basemap
30-
warpimage, bluemarble, shadedrelief, and etopo methods. PIL should
31-
work on Python 2.x. Pillow is a maintained fork of PIL.
25+
* [Pillow](https://github.com/python-pillow/Pillow). It is needed for
26+
the methods `Basemap.bluemarble`, `Basemap.etopo`,
27+
`Basemap.shadedrelief` and `Basemap.warpimage`.
3228

3329
## Installation
3430

@@ -39,45 +35,50 @@ python -m pip install basemap-data
3935
python -m pip install basemap-data-hires
4036
```
4137

42-
Precompiled binaries for GNU/Linux are also available in PyPI:
38+
Precompiled `basemap` binary wheels for Windows and GNU/Linux are also
39+
available in PyPI (architectures x86 and x64, Python 2.7 and 3.5+):
4340
```sh
4441
python -m pip install basemap
4542
```
4643

4744
Otherwise, you will need to install `basemap` from source as follows:
4845

4946
1. Install pre-requisite Python modules:
50-
- `cython`.
51-
- `numpy`.
47+
- [cython](https://github.com/cython/cython).
48+
- [numpy](https://github.com/numpy/numpy).
5249

5350
2. Download the `basemap` source code and move to the `packages/basemap`
5451
folder:
5552
```sh
56-
git clone https://github.com/matplotlib/basemap.git
53+
git clone --depth 1 https://github.com/matplotlib/basemap.git
5754
cd basemap/packages/basemap
5855
```
5956

60-
3. Build the GEOS library. You may use the helper provided in `utils`, i.e.
57+
3. Build the [GEOS](https://github.com/libgeos/geos) library. You may
58+
use the helper provided in `utils`, i.e.
6159
```sh
6260
export GEOS_DIR=<your desired location>
63-
python -c "import utils; utils.GeosLibrary('3.6.5').build(installdir='${GEOS_DIR}')"
61+
python -c "import utils; utils.GeosLibrary('3.5.1').build(installdir='${GEOS_DIR}')"
6462
```
65-
or you can link directly to the system library if it is already installed.
66-
`GEOS_DIR` must point to the GEOS installation prefix; e.g. if `libgeos_c.so`
67-
is located in `/usr/lib` and `geos_c.h` is located in `/usr/include`, then
68-
you must set `GEOS_DIR` to `/usr`.
63+
or you can link directly to the system library if it is already
64+
installed. `GEOS_DIR` must point to the GEOS installation prefix;
65+
e.g. if `libgeos_c.so` is located in `/usr/lib` and `geos_c.h` is
66+
located in `/usr/include`, then you must set `GEOS_DIR` to `/usr`.
6967

70-
4. Build the basemap wheel from the `packages/basemap` folder and install it:
68+
4. Build and install the `basemap` binary wheel:
7169
```sh
72-
python setup.py bdist_wheel
73-
python -m pip install dist/*.whl
70+
python -m pip install .
7471
```
72+
On Linux, if your Python was installed through a package management
73+
system, make sure that you have the Python header `Python.h` required
74+
to build Cython extensions (e.g. on Debian-like systems, you should
75+
have the package `python-dev` installed).
7576

76-
5. Check that the package installed correctly by executing in the terminal:
77+
5. Check that the package installed correctly by executing:
7778
```sh
7879
python -c "from mpl_toolkits.basemap import Basemap"
7980
```
80-
You can also test the `basemap` examples available in the `examples` folder.
81+
You can also test the examples available in the `examples` folder.
8182

8283
## License
8384

@@ -89,8 +90,8 @@ The source code and data assets are under the following licenses:
8990
* The EPSG file and the JPG images are also under the [MIT] license.
9091
* `basemap-data-hires`: [LGPL-3.0-or-later].
9192

92-
For a full description, please visit the README and LICENSE files of
93-
each package in the corresponding package folders.
93+
For a full description, please visit the `README` and `LICENSE` files of
94+
each package.
9495

9596
[MIT]:
9697
https://spdx.org/licenses/MIT.html
@@ -101,7 +102,7 @@ https://spdx.org/licenses/LGPL-3.0-or-later.html
101102

102103
## Documentation
103104

104-
See http://matplotlib.github.io/basemap/
105+
See https://matplotlib.github.io/basemap/
105106

106107
See scripts in `examples` directory for example usage.
107108

0 commit comments

Comments
 (0)