8000 Merge pull request #1206 from mdboom/readme_and_links · matplotlib/matplotlib@dffbad1 · GitHub
[go: up one dir, main page]
Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit dffbad1

Browse files
mdboommdboom
committed
Merge pull request #1206 from mdboom/readme_and_links
README and links fixes
2 parents 15fd0ae + d6765ce commit dffbad1

22 files changed

+99
-228
lines changed

‎INSTALL

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,9 @@ are available for download `here <http://www.python.org/download>`_,
3737
but OS X users please read :ref:`which-python-for-osx`.
3838

3939
Once you have python up and running, you will need to install `numpy
40-
<http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103>`_.
41-
numpy provides high-performance array data structures and mathematical
42-
functions, and is a requirement for matplotlib. You can test your
43-
progress::
40+
<http://www.numpy.org/>`_. numpy provides high-performance array data
41 6D4E +
structures and mathematical functions, and is a requirement for
42+
matplotlib. You can test your progress::
4443

4544
>>> import numpy
4645
>>> print numpy.__version__
@@ -52,7 +51,7 @@ interactive shell for python that is matplotlib-aware.
5251

5352
Next, we need to get matplotlib installed. We provide prebuilt
5453
binaries for OS X and Windows on the matplotlib `download
55-
<http://sourceforge.net/projects/matplotlib/files/>`_ page. Click on
54+
<https://github.com/matplotlib/matplotlib/downloads/>`_ page. Click on
5655
the latest release of the "matplotlib" package, choose your python
5756
version (2.6, 2.7 or 3.2) and your platform (macosx or win32). If you
5857
have any problems, please check the :ref:`installing-faq`, search
@@ -119,13 +118,13 @@ subdirectory.
119118
Installing from source
120119
======================
121120

122-
If you are interested in contributing to matplotlib
123-
development, running the latest source code, or just like to
124-
build everything yourself, it is not difficult to build matplotlib
125-
from source. Grab the latest *tar.gz* release file from `sourceforge
126-
<http://sourceforge.net/project/showfiles.php?group_id=80706>`_, or if
127-
you want to develop matplotlib or just need the latest bugfixed
128-
version, grab the latest git version :ref:`install-from-git`.
121+
If you are interested in contributing to matplotlib development,
122+
running the latest source code, or just like to build everything
123+
yourself, it is not difficult to build matplotlib from source. Grab
124+
the latest *tar.gz* release file from `the download page
125+
<https://github.com/matplotlib/matplotlib/downloads>`_, or if you want
126+
to develop matplotlib or just need the latest bugfixed version, grab
127+
the latest git version :ref:`install-from-git`.
129128

130129
Once you have satisfied the requirements detailed below (mainly
131130
python, numpy, libpng and freetype), you can build matplotlib::
@@ -157,11 +156,12 @@ Build requirements
157156
These are external packages which you will need to install before
158157
installing matplotlib. Windows users only need the first two (python
159158
and numpy) since the others are built into the matplotlib Windows
160-
installers available for download at the sourceforge site. If you are
159+
installers available for download at `the download page
160+
<https://github.com/matplotlib/matplotlib/downloads>_`. If you are
161161
building on OSX, see :ref:`build_osx`. If you are installing
162-
dependencies with a package manager on Linux, you may need to install the
163-
development packages (look for a "-dev" postfix) in addition to the
164-
libraries themselves.
162+
dependencies with a package manager on Linux, you may need to install
163+
the development packages (look for a "-dev" postfix) in addition to
164+
the libraries themselves.
165165

166166
.. note::
167167

@@ -179,12 +179,11 @@ libraries themselves.
179179
This does not build matplotlib, but it does get the install the
180180
build dependencies, which will make building from source easier.
181181

182-
:term:`python` 2.6 (or later but not python3)
183-
matplotlib requires python 2.6 or later (`download <http://www.python.org/download/>`__)
182+
:term:`python` 2.6, 2.7, 3.1 or 3.2
183+
`Download python <http://www.python.org/download/>`_.
184184

185185
:term:`numpy` |minimum_numpy_version| (or later)
186-
array support for python (`download
187-
<http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103>`__)
186+
array support for python (`download <http://numpy.org>`_)
188187

189188
libpng 1.2 (or later)
190189
library for loading and saving :term:`PNG` files (`download

‎README.txt

Lines changed: 2 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,9 @@
1-
matplotlib for MacOS X 10.3.9 or later and Python 2.5 and Python 2.6
2-
31
matplotlib is a python 2D plotting library which produces publication
42
quality figures in a variety of hardcopy formats and interactive
53
environments across platforms. matplotlib can be used in python
64
scripts, the python and ipython shell (ala matlab or mathematica), web
75
application servers, and various graphical user interface toolkits.
86

9-
Home page: <http://matplotlib.sourceforge.net/>
10-
11-
Before running matplotlib, you must install numpy. Binary installers
12-
for all these packages are available here:
13-
14-
<http://pythonmac.org/packages/py25-fat/index.html>.
15-
16-
*** Setup from source using Pip ***
17-
18-
::
19-
20-
pip install -e https://github.com/matplotlib/matplotlib.git#egg=Package
21-
22-
*** Back Ends ***
23-
24-
You may use TkAgg or WXAgg back ends; Qt and GTK support is not
25-
provided in this package. By default this matplotlib uses TkAgg
26-
because Tcl/Tk is included with MacOS X.
27-
28-
If you wish to use WXAgg then:
29-
* Install wxPython from:
30-
<http://pythonmac.org/packages/py25-fat/index.html>.
31-
* Configure a matplotlibrc file, as described below.
32-
33-
For TkAgg you may use Apple's built-in Tcl/Tk or install your own 8.4.x
34-
35-
*** Configuring a matplotlibrc file ***
36-
37-
If you wish to change any matplotlib settings, create a file:
38-
~/.matplotlib/matplotlibrc
39-
40-
41-
that contains at least the following information. The values shown are
42-
the defaults in the internal matplotlibrc file; change them as you see
43-
fit:
44-
45-
# the default backend; one of GTK GTKAgg GTKCairo FltkAgg QtAgg TkAgg WXAgg
46-
# Agg Cairo GD GDK Paint PS PDF SVG Template
47-
backend : TkAgg
48-
interactive : False # see http://matplotlib.sourceforge.net/interactive.html
7+
Home page: <http://matplotlib.org/>
498

50-
See also
51-
<http://matplotlib.sourceforge.net/users/customizing.html>
9+
For installation instructions and requirements, see the INSTALL file.

‎doc/_templates/index.html

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,8 @@ <h1>Introduction</h1>
102102

103103
<h1>Download</h1>
104104

105-
Matplotlib 1.1.1 is available for
106-
<a href="https://sourceforge.net/projects/matplotlib/files/matplotlib/matplotlib-1.1.1/">download</a>.
105+
Matplotlib is available for
106+
<a href="https://github.com/matplotlib/matplotlib/downloads">download</a>.
107107

108108
<h1>Documentation</h1>
109109

@@ -173,7 +173,9 @@ <h1>Open source</h1>
173173

174174
<p>Please
175175
consider <a href="http://sourceforge.net/project/project_donations.php?group_id=80706">donating</a>
176-
to support matplotlib development.</p>
176+
to support matplotlib development or to
177+
the <a href="http://numfocus.org/johnhunter/">John Hunter Memorial
178+
Fund</a>.</p>
177179

178180
<p>The matplotlib <a href="{{ pathto('users/license') }}">license</a>
179181
is based on the Python Software Foundation

‎doc/devel/coding_guide.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -323,16 +323,16 @@ Writing examples
323323
================
324324

325325
We have hundreds of examples in subdirectories of
326-
:file:`matplotlib/examples`, and these are automatically
327-
generated when the website is built to show up both in the `examples
328-
<http://matplotlib.sourceforge.net/examples/index.html>`_ and `gallery
329-
<http://matplotlib.sourceforge.net/gallery.html>`_ sections of the
330-
website. Many people find these examples from the website, and do not
331-
have ready access to the file:`examples` directory in which they
332-
reside. Thus any example data that is required for the example should
333-
be added to the `sample_data
334-
<https://github.com/matplotlib/sample_data>`_ git repository.
335-
Then in your example code you can load it into a file handle with::
326+
:file:`matplotlib/examples`, and these are automatically generated
327+
when the website is built to show up both in the `examples
328+
<http://matplotlib.org/examples/index.html>`_ and `gallery
329+
<http://matplotlib.org/gallery.html>`_ sections of the website. Many
330+
people find these examples from the website, and do not have ready
331+
access to the file:`examples` directory in which they reside. Thus
332+
any example data that is required for the example should be added to
333+
the `sample_data <https://github.com/matplotlib/sample_data>`_ git
334+
repository. Then in your example code you can load it into a file
335+
handle with::
336336

337337
import matplotlib.cbook as cbook
338338
fh = cbook.get_sample_data('mydata.dat')
@@ -351,11 +351,11 @@ object::
351351

352352
Writing a new pyplot function
353353
=============================
354-
A large portion of the pyplot interface is automatically generated by the
354+
A large portion of the pyplot interface is automatically generated by the
355355
`boilerplate.py` script (in the root of the source tree). To add or remove
356356
a plotting method from pyplot, edit the appropriate list in `boilerplate.py`
357-
and then run the script which will update the content in
358-
`lib/matplotlib/pyplot.py`. Both the changes in `boilerplate.py` and
357+
and then run the script which will update the content in
358+
`lib/matplotlib/pyplot.py`. Both the changes in `boilerplate.py` and
359359
`lib/matplotlib/pyplot.py` should be checked into the repository.
360360

361361
Testing

‎doc/devel/gitwash/this_project.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.. matplotlib
2-
.. _matplotlib: http://matplotlib.sourceforge.net
2+
.. _matplotlib: http://matplotlib.org
33
.. _`matplotlib github`: http://github.com/matplotlib/matplotlib
44

55
.. _`matplotlib mailing list`: https://lists.sourceforge.net/lists/listinfo/matplotlib-devel

‎doc/devel/release_guide.rst

Lines changed: 6 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -93,61 +93,13 @@ Packaging
9393

9494
.. _release-candidate-testing:
9595

96-
Release candidate testing:
97-
============================
98-
99-
Post the release candidates to
100-
http://matplotlib.sf.net/release-candidates and post a message to
101-
matplotlib-users and devel requesting testing. To post to the server,
102-
you can do::
103-
104-
> scp somefile.tgz jdh2358,matplotlib@shell.sf.net:/home/groups/m/ma/matplotlib/htdocs/release-candidates/
105-
106-
replacing 'jdh2358' with your sourceforge login.
107-
108-
109-
Any changes to fix bugs in the release candidate should be fixed in
110-
the release branch and merged into the trunk.
111-
112-
113-
.. _release-uploading:
114-
115-
Uploading
116-
=========
117-
118-
* Post the win32 and OS-X binaries for testing and make a request on
119-
matplotlib-devel for testing. Pester us if we don't respond
120-
121-
122-
* ftp the source and binaries to the anonymous FTP site::
123-
124-
mpl> git clean
125-
mpl> python setup.py sdist
126-
mpl> cd dist/
127-
dist> sftp jdh2358@frs.sourceforge.net
128-
Connecting to frs.sourceforge.net...
129-
sftp> cd uploads
130-
sftp> ls
131-
sftp> lls
132-
matplotlib-0.98.2.tar.gz
133-
sftp> put matplotlib-0.98.2.tar.gz
134-
Uploading matplotlib-0.98.2.tar.gz to /incoming/j/jd/jdh2358/uploads/matplotlib-0.98.2.tar.gz
135-
136-
* go https://sourceforge.net/project/admin/explorer.php?group_id=80706 and do a
137-
file release. Click on the "Admin" tab to log in as an admin, and
138-
then the "File Releases" tab. Go to the bottom and click "add
139-
release" and enter the package name but not the version number in
140-
the "Package Name" box. You will then be prompted for the "New
141-
release name" at which point you can add the version number, eg
142-
somepackage-0.1 and click "Create this release".
143-
144-
You will then be taken to a fairly self explanatory page where you
145-
can enter the Change notes, the release notes, and select which
146-
packages from the incoming ftp archive you want to include in this
147-
release. For each binary, you will need to select the platform and
148-
file type, and when you are done you click on the "notify users who
149-
are monitoring this package link"
96+
Release candidate testing
97+
=========================
15098

99+
Post the release candidates tarballs to the `matplotlib download page
100+
<https://github.com/matplotlib/matplotlib/downloads>`_. If you have
101+
developer rights, you should see an "Upload a new file" section
102+
there.
151103

152104
.. _release-announcing:
153105

‎doc/faq/installing_faq.rst

Lines changed: 15 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -209,15 +209,15 @@ Installer.app, or a binary OSX egg, which you can install via
209209
setuptools' easy_install.
210210

211211
The mkpg installer will have a "zip" extension, and will have a name
212-
like :file:`matplotlib-0.99.0.rc1-py2.5-macosx10.5_mpkg.zip`.
212+
like :file:`matplotlib-1.2.0-py2.7-macosx10.5_mpkg.zip`.
213213
The name of the installer depends on which versions of python, matplotlib,
214214
and OSX it was built for. You need to unzip this file using either the
215215
"unzip" command, or simply double clicking on the it. Then when you
216216
double-click on the resulting mpkd, which will have a name like
217-
:file:`matplotlib-0.99.0.rc1-py2.5-macosx10.5.mpkg`, it will run the
217+
:file:`matplotlib-1.2.0-py2.7-macosx10.5.mpkg`, it will run the
218218
Installer.app, prompt you for a password if you need system-wide
219219
installation privileges, and install to a directory like
220-
:file:`/Library/Python/2.5/site-packages/` (exact path depends on your
220+
:file:`/Library/Python/2.7/site-packages/` (exact path depends on your
221221
python version). This directory may not be in your python 'path' variable,
222222
so you should test your installation with::
223223

@@ -231,7 +231,7 @@ If you get an error like::
231231

232232
then you will need to set your PYTHONPATH, eg::
233233

234-
export PYTHONPATH=/Library/Python/2.5/site-packages:$PYTHONPATH
234+
export PYTHONPATH=/Library/Python/2.7/site-packages:$PYTHONPATH
235235

236236
See also ref:`environment-variables`.
237237

@@ -248,40 +248,14 @@ can try::
248248

249249
> easy_install matplotlib
250250

251-
which should grab the latest egg from the sourceforge site, but sometimes
252-
the naming conventions for OSX eggs can be broken (see below).
253-
Therefore, there is no guarantee the right egg will be found. We recommend
254-
you download the latest egg from our `download site
255-
<http://sourceforge.net/projects/matplotlib/files/>`_ directly to your
251+
which should grab the latest egg from github, but sometimes the naming
252+
conventions for OSX eggs can be broken (see below). Therefore, there
253+
is no guarantee the right egg will be found. We recommend you download
254+
the latest egg from our `download site
255+
<https://github.com/matplotlib/matplotlib/downloads>`_ directly to your
256256
harddrive, and manually install it, eg::
257257

258-
> easy_install --install-dir=~/dev/lib/python2.5/site-packages/ matplotlib-0.99.0.rc1-py2.5-macosx-10.5-i386.egg
259-
260-
Naming convention issues
261-
^^^^^^^^^^^^^^^^^^^^^^^^
262-
.. note::
263-
This should no longer be an issue. If it is, please
264-
report it to the mailing list.
265-
266-
Some users have reported problems with the egg for 0.98 from the
267-
matplotlib download site, with ``easy_install``, getting an error::
268-
269-
> easy_install ./matplotlib-0.98.0-py2.5-macosx-10.3-fat.egg
270-
Processing matplotlib-0.98.0-py2.5-macosx-10.3-fat.egg
271-
removing '/Library/Python/2.5/site-packages/matplotlib-0.98.0-py2.5-
272-
...snip...
273-
Reading http://matplotlib.sourceforge.net
274-
Reading http://cheeseshop.python.org/pypi/matplotlib/0.91.3
275-
No local packages or download links found for matplotlib==0.98.0
276-
error: Could not find suitable distribution for
277-
Requirement.parse('matplotlib==0.98.0')
278-
279-
If you rename ``matplotlib-0.98.0-py2.5-macosx-10.3-fat.egg`` to
280-
``matplotlib-0.98.0-py2.5.egg``, ``easy_install`` will install it from
281-
the disk. Many Mac OS X eggs have cruft at the end of the filename,
282-
which prevents their installation through easy_install. Renaming is
283-
all it takes to install them; still, it's annoying.
284-
258+
> easy_install --install-dir=~/path/to/site-packages/ matplotlib-1.2.0-py2.7-macosx-10.5-i386.egg
285259

286260
.. _install_from_source_on_osx_epd:
287261

@@ -349,13 +323,11 @@ Binary installers for Windows
349323

350324
If you have already installed python, you can use one of the
351325
matplotlib binary installers for windows -- you can get these from the
352-
`sourceforge download
353-
<http://sourceforge.net/project/platformdownload.php?group_id=80706>`_
354-
site. Choose the files that match your version of python (eg
355-
``py2.5`` if you installed Python 2.5) which have the ``exe``
356-
extension. If you haven't already installed python, you can get the
357-
official version from the `python web site
358-
<http://python.org/download/>`_.
326+
`download <https://github.com/matplotlib/matplotlib/downloads>`_ site.
327+
Choose the files that match your version of python (eg ``py2.7`` if
328+
you installed Python 2.7) which have the ``exe`` extension. If you
329+
haven't already installed python, you can get the official version
330+
from the `python web site <http://python.org/download/>`_.
359331

360332
There are also two packaged distributions of python that come
361333
preloaded with matplotlib and many other tools like ipython, numpy,

‎doc/pyplots/README

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,3 @@ tex_demo.py and tex_unicode_demo.py:
88

99
plotmap.py:
1010
basemap toolkit
11-
12-
some data files - do a svn co
13-
https://matplotlib.svn.sourceforge.net/svnroot/matplotlib/trunk/htdocs/screenshots/data/
14-
to get the data and then set the datadir variable in the
15-
plotmap.py file to point to this data direcotry

‎doc/users/image_tutorial.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,9 @@ object:
226226
imgplot = plt.imshow(lum_img)
227227
imgplot.set_cmap('spectral')
228228

229-
There are many other colormap schemes available. See the `list and images of the colormaps <http://matplotlib.sourceforge.net/examples/pylab_examples/show_colormaps.html>`_.
229+
There are many other colormap schemes available. See the `list and
230+
images of the colormaps
231+
<http://matplotlib.org/examples/pylab_examples/show_colormaps.html>`_.
230232

231233
.. _`Color Bars`:
232234

‎doc/users/legend_guide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ Multicolumn Legend
123123
By specifying the keyword argument *ncol*, you can have a multi-column
124124
legend. Also, mode="expand" horizontally expand the legend to fill the
125125
axes area. See `legend_demo3.py
126-
<http://matplotlib.sourceforge.net/examples/pylab_examples/legend_demo3.html>`_
126+
<http://matplotlib.org/examples/pylab_examples/legend_demo3.html>`_
127127
for example.
128128

129129

0 commit comments

Comments
 (0)
0