Skip to content

Commit b82a952

Browse files
committed
Consolide README file at project root folder
1 parent 642aea8 commit b82a952

File tree

2 files changed

+48
-102
lines changed

2 files changed

+48
-102
lines changed

README.md

Lines changed: 48 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,12 @@
1-
# Basemap
1+
# basemap
22

3-
Plot on map projections (with coastlines and political boundaries)
4-
using matplotlib.
5-
6-
## Requirements
7-
8-
Basic requirements are the following:
9-
10-
* Python 2.6 (or higher)
11-
* [matplotlib](https://github.com/matplotlib/matplotlib)
12-
* [numpy](https://github.com/numpy/numpy)
13-
* [pyproj](https://github.com/pyproj4/pyproj)
14-
* [pyshp](https://github.com/GeospatialPython/pyshp)
15-
16-
Optional requirements include:
17-
18-
* [OWSLib](https://github.com/geopython/OWSLib). It is needed for the
19-
method `Basemap.wmsimage`.
20-
21-
* [Pillow](https://github.com/python-pillow/Pillow). It is needed for
22-
the methods `Basemap.bluemarble`, `Basemap.etopo`,
23-
`Basemap.shadedrelief` and `Basemap.warpimage`.
3+
Plot on map projections (with coastlines and political boundaries) using
4+
[`matplotlib`].
245

256
## Installation
267

27-
The `basemap-data` and `basemap-data-hires` packages are available in
28-
PyPI and can be installed with [`pip`](https://pip.pypa.io/):
29-
```sh
30-
python -m pip install basemap-data
31-
python -m pip install basemap-data-hires
32-
```
33-
34-
Precompiled `basemap` binary wheels for Windows and GNU/Linux
35-
(architectures x86 and x64, Python 2.7 and 3.5+) as well as for MacOS
36-
(architectures x64 and arm64, Python 3.9+) are also available in PyPI:
8+
Precompiled binary wheels for Windows, GNU/Linux and MacOS are available
9+
on PyPI and can be installed with [`pip`]:
3710
```sh
3811
python -m pip install basemap
3912
```
@@ -45,11 +18,9 @@ on GitHub as indicated in the following steps:
4518
- [cython](https://github.com/cython/cython)
4619
- [numpy](https://github.com/numpy/numpy)
4720

48-
2. Download the `basemap` source code and move to the `packages/basemap`
49-
folder:
21+
2. Download the `basemap` source code:
5022
```sh
5123
git clone --depth 1 https://github.com/matplotlib/basemap.git
52-
cd basemap/packages/basemap
5324
```
5425

5526
3. Build the [GEOS](https://github.com/libgeos/geos) library. You may
@@ -78,29 +49,30 @@ on GitHub as indicated in the following steps:
7849
python -c "from mpl_toolkits.basemap import Basemap"
7950
```
8051

81-
## License
52+
## Requirements
53+
54+
This package depends on [`basemap-data`] with the basic [`basemap`]
55+
data assets supporting the essential functionality.
8256

83-
The source code and data assets are under the following licenses:
57+
This package depends optionally on [`basemap-data-hires`] with the
58+
high-resolution data assets, which can be installed with [`pip`]:
59+
```sh
60+
python -m pip install basemap-data-hires
61+
```
8462

85-
* `basemap`: [MIT].
86-
* GEOS bundled dynamic library is under the [LGPL-2.1-only] license.
87-
* `basemap-data`: [LGPL-3.0-or-later].
88-
* The EPSG file and the JPG images are also under the [MIT] license.
89-
* `basemap-data-hires`: [LGPL-3.0-or-later].
63+
This package depends optionally on [`OWSLib`] for the `Basemap` method
64+
`Basemap.wmsimage`.
9065

91-
For a full description, please visit the `README` and `LICENSE` files of
92-
each package.
66+
## License
9367

94-
[MIT]:
95-
https://spdx.org/licenses/MIT.html
96-
[LGPL-2.1-only]:
97-
https://spdx.org/licenses/LGPL-2.1-only.html
98-
[LGPL-3.0-or-later]:
99-
https://spdx.org/licenses/LGPL-3.0-or-later.html
68+
The library is licensed under the terms of the [MIT] license (see
69+
[`LICENSE`]). The GEOS dynamic library bundled with the package wheels
70+
is provided under the terms of the [LGPL-2.1-only] license as given in
71+
[`LICENSE.geos`].
10072

10173
## Documentation
10274

103-
See https://matplotlib.org/basemap/
75+
See https://matplotlib.org/basemap/.
10476

10577
See scripts in `examples` directory for example usage.
10678

@@ -130,4 +102,28 @@ situations, what is the inside of a coastline polygon can be ambiguous,
130102
and the outside may be filled instead of the inside. A workaround is to
131103
change the map projection region slightly or mask the land areas with
132104
the `Basemap.drawlsmask` method instead of filling the coastline
133-
polygons (this is illustrated in the `ortho_demo.py` example).
105+
polygons (this is illustrated in the `ortho_demo.py` example).
106+
107+
108+
[`pip`]:
109+
https://pip.pypa.io/
110+
[`matplotlib`]:
111+
https://matplotlib.org/
112+
[`basemap`]:
113+
https://matplotlib.org/basemap/
114+
[`basemap-data`]:
115+
https://pypi.org/project/basemap-data
116+
[`basemap-data-hires`]:
117+
https://pypi.org/project/basemap-data-hires
118+
[`OWSLib`]:
119+
https://pypi.org/project/OWSLib
120+
121+
[MIT]:
122+
https://spdx.org/licenses/MIT.html
123+
[LGPL-2.1-only]:
124+
https://spdx.org/licenses/LGPL-2.1-only.html
125+
126+
[`LICENSE`]:
127+
https://github.com/matplotlib/basemap/blob/v2.0.0/LICENSE
128+
[`LICENSE.geos`]:
129+
https://github.com/matplotlib/basemap/blob/v2.0.0/LICENSE.geos

packages/basemap/README.md

Lines changed: 0 additions & 50 deletions
This file was deleted.

0 commit comments

Comments
 (0)