Skip to content

Commit 2285c16

Browse files
committed
Updated documentation. Added important EoL announcement.
1 parent b6fdddb commit 2285c16

File tree

4 files changed

+31
-16
lines changed

4 files changed

+31
-16
lines changed

doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242

4343
# General substitutions.
4444
project = 'Basemap Matplotlib Toolkit'
45-
copyright = '2011, Jeffrey Whitaker'
45+
copyright = '2011, Jeffrey Whitaker; 2016 The matplotlib development team'
4646

4747
# The default replacements for |version| and |release|, also used in various
4848
# other places throughout the built documents.

doc/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Welcome to the Matplotlib Basemap Toolkit documentation!
2-
========================================================
1+
Welcome to the Matplotlib Basemap Toolkit documentation
2+
=======================================================
33

44
.. toctree::
55
:maxdepth: 2

doc/users/installing.rst

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,28 +21,27 @@ Python 2.4 (or later, including Python 3)
2121
numpy 1.2.1 (or later)
2222
array support for python (`download <http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103>`__)
2323

24-
**Required libraries that ship with basemap**
24+
`PROJ4 <http://trac.osgeo.org/proj/>`__ Cartographic Projections Library.
25+
26+
**Required library that ship with basemap**
2527

2628
`GEOS <http://trac.osgeo.org/geos/>`__ (Geometry Engine - Open Source) library 3.1.1 or later.
2729
Source code is included in the geos-3.3.3 directory.
2830
When building from source, must be built and installed separately
2931
from basemap (see build instructions below).
3032
Included in Windows binary installers.
3133

32-
`PROJ4 <http://trac.osgeo.org/proj/>`__ Cartographic Projections Library.
33-
Patched version automatically built into basemap.
34-
3534
**Optional libraries**
3635

37-
PIL
38-
Python Imaging Library (`download <http://www.pythonware.com/products/pil/>`__),
36+
Pillow
37+
Python Imaging Library (`download <https://python-pillow.org/>`__),
3938
only needed for :func:`~mpl_toolkits.basemap.Basemap.bluemarble`, :func:`~mpl_toolkits.basemap.Basemap.etopo`, :func:`~mpl_toolkits.basemap.Basemap.shadedrelief` and :func:`~mpl_toolkits.basemap.Basemap.warpimage` instance methods.
4039

4140
Installation
4241
============
4342

4443
Download either Windows binary installers or source tarballs
45-
`here <http://sourceforge.net/projects/matplotlib/files/matplotlib-toolkits/>`__.
44+
`here <https://github.com/matplotlib/basemap/releases/>`__.
4645

4746
To install from the source, follow these steps:
4847

doc/users/intro.rst

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,30 @@ datasets (from `Generic Mapping Tools <http://gmt.soest.hawaii.edu/>`_)
2121
are provided, along with methods for plotting them. The `GEOS library
2222
<http://geos.refractions.net>`_ is used internally to clip the coastline and polticial boundary features to the desired map projection region.
2323

24-
Basemap provides facilities for reading `shapefiles
25-
<http://en.wikipedia.org/wiki/Shapefile>`_.
26-
2724
Basemap is geared toward the needs of earth scientists, particular
28-
oceanographers and meteorologists. I originally wrote Basemap to help in my
29-
research (climate and weather forecasting), since at the time
25+
oceanographers and meteorologists. Jeff Whitaker originally wrote Basemap
26+
to help in his research (climate and weather forecasting), since at the time
3027
`CDAT <http://www-pcmdi.llnl.gov/software/cdat/support/vcs/vcs.html>`_ was
3128
the only other tool in python for plotting data on map projections. Over
3229
the years, the capabilities of Basemap have evolved as scientists in other
3330
disciplines (such as biology, geology and geophysics) requested and
34-
contributed new features.
31+
contributed new features.
32+
33+
Cartopy, New Management, and EoL Announcement
34+
=============================================
35+
36+
Starting in 2016, Basemap came under new management. The
37+
`Cartopy project <http://scitools.org.uk/cartopy/>`_ will replace
38+
Basemap, but it hasn't yet implemented all of Basemap's features.
39+
All new software development should try to use CartoPy whenever possible,
40+
and existing software should start the process of switching over to use
41+
Cartopy. All maintenance and development efforts should be focused on
42+
Cartopy.
43+
44+
Ben Root has volunteered to take over maintenance of Basemap until 2020.
45+
Pull requests will be reviewed, and bugs will be fixed. Also, the
46+
maintenance will ensure compatibility with packages like NumPy and matplotlib.
47+
New features will be accepted, but we stress that new development efforts
48+
should be focused on Cartopy. When Python 2.7 is officially EoL'ed in 2020,
49+
a release of Basemap will be made and support from Ben Root will end.
50+

0 commit comments

Comments
 (0)