Skip to content

Commit 665ee84

Browse files
authored
Merge pull request #442 from WeatherGod/doc_updates
Updating old sourceforge links. Other doc improvments and such.
2 parents aef742a + e7d6a62 commit 665ee84

File tree

6 files changed

+26
-12
lines changed

6 files changed

+26
-12
lines changed

doc/index.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,11 @@ Indices and tables
1313
* :ref:`genindex`
1414
* :ref:`modindex`
1515
* :ref:`search`
16+
17+
Deprecation Notice
18+
==================
19+
20+
Basemap is deprecated in favor of the
21+
`Cartopy project <http://scitools.org.uk/cartopy/>`_.
22+
See notes in :ref:`deprecation_notice` for more details.
23+

doc/users/download.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
Download
22
========
33

4-
Source code and Windows installers can be found
5-
`here <http://sourceforge.net/projects/matplotlib/files/matplotlib-toolkits/>`__
4+
Source code can be found
5+
`here <http://github.com/matplotlib/basemap/releases/>`__
6+
7+
The recommended installation method is using anaconda through the
8+
conda-forge channel. Basemap is no longer uploaded to PyPI due to its
9+
size and non-python external dependencies.

doc/users/examples.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,19 @@ There are a number of Basemap instance methods for plotting data:
2020
* :func:`~mpl_toolkits.basemap.Basemap.drawgreatcircle`: draw a `great circle <http://en.wikipedia.org/wiki/Great_circle>`__.
2121

2222
Many of these instances methods simply forward to the corresponding matplotlib
23-
`Axes <http://matplotlib.sourceforge.net/api/axes_api.html>`__ instance method,
23+
`Axes <https://matplotlib.org/api/axes_api.html>`__ instance method,
2424
with some extra pre/post processing and argument checking.
2525
You can also plot on the map directly with the matplotlib
26-
`pyplot <http://matplotlib.sourceforge.net/api/pyplot_api.html>`__ interface,
27-
or the `OO api <http://matplotlib.sourceforge.net/examples/api/index.html>`__,
28-
using the `Axes <http://matplotlib.sourceforge.net/api/axes_api.html>`__ instance
26+
`pyplot <https://matplotlib.org/api/pyplot_api.html>`__ interface,
27+
or the `OO api <https://matplotlib.org/examples/api/index.html>`__,
28+
using the `Axes <https://matplotlib.org/api/axes_api.html>`__ instance
2929
associated with the Basemap.
3030

3131
For more specifics of how to use the Basemap instance methods,
3232
see :ref:`api-index`.
3333

3434
Here are the examples (many of which utilize the
35-
`netcdf4-python <http://netcdf4-python.googlecode.com>`__ module
35+
`netcdf4-python <http://unidata.github.io/netcdf4-python/>`__ module
3636
to retrieve datasets over http):
3737

3838
* Plot contour lines on a basemap
@@ -74,4 +74,4 @@ to retrieve datasets over http):
7474

7575
* Draw day-night terminator on a map.
7676

77-
.. plot:: users/figures/plotdaynight.py
77+
.. plot:: users/figures/plotdaynight.py

doc/users/intro.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ are other libraries that provide similar capabilities in Python.
1313

1414
Basemap does not do any plotting on it's own, but provides the facilities to transform coordinates to one of 25 different map projections (using the
1515
`PROJ.4 <http://trac.osgeo.org/proj/>`_ C library). `Matplotlib
16-
<http://matplotlib.sourceforge.net>`_ is then
16+
<https://matplotlib.org>`_ is then
1717
used to plot contours, images, vectors, lines or points
1818
in the transformed coordinates.
1919
Shoreline, river and political boundary
@@ -30,6 +30,8 @@ the years, the capabilities of Basemap have evolved as scientists in other
3030
disciplines (such as biology, geology and geophysics) requested and
3131
contributed new features.
3232

33+
.. _deprecation_notice:
34+
3335
Cartopy, New Management, and EoL Announcement
3436
=============================================
3537

@@ -42,7 +44,7 @@ Cartopy. All maintenance and development efforts should be focused on
4244
Cartopy.
4345

4446
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
47+
Pull requests will be reviewed, and regressions will be fixed. Also, this
4648
maintenance will ensure compatibility with packages like NumPy and Matplotlib.
4749
New features will be accepted, but we stress that new development efforts
4850
should be focused on Cartopy. When Python 2.7 is officially EoL'ed in 2020,

requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
matplotlib>=1.0.0
1+
matplotlib>=1.0.0,!=3.0.1
22
numpy>=1.2.1
33
pyproj>=1.9.3
44
pyshp>=1.2.0

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ def checkversion(GEOS_dir):
126126
on map projections with coastlines, lakes, rivers and political boundaries.
127127
See http://matplotlib.org/basemap/users/examples.html for
128128
examples of what it can do.""",
129-
url = "http://matplotlib.org/basemap/",
129+
url = "https://matplotlib.org/basemap/",
130130
download_url = "https://github.com/matplotlib/basemap/archive/v{0}rel.tar.gz".format(__version__),
131131
author = "Jeff Whitaker",
132132
author_email = "[email protected]",

0 commit comments

Comments
 (0)