Permalink
Browse files

Significantly simplify the way out of date README.txt file. Closes #1091

.

Also updates all of the sourceforge documentation links to matplotlib.org.

Updates the Sourceforge download link to Github.
  • Loading branch information...
1 parent b5eb1d0 commit ede1640cd32e001808a816141c14cbea9accafbb @mdboom mdboom committed Sep 5, 2012
View
39 INSTALL
@@ -37,10 +37,9 @@ are available for download `here <http://www.python.org/download>`_,
but OS X users please read :ref:`which-python-for-osx`.
Once you have python up and running, you will need to install `numpy
-<http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103>`_.
-numpy provides high-performance array data structures and mathematical
-functions, and is a requirement for matplotlib. You can test your
-progress::
+<http://www.numpy.org/>`_. numpy provides high-performance array data
+structures and mathematical functions, and is a requirement for
+matplotlib. You can test your progress::
>>> import numpy
>>> print numpy.__version__
@@ -52,7 +51,7 @@ interactive shell for python that is matplotlib-aware.
Next, we need to get matplotlib installed. We provide prebuilt
binaries for OS X and Windows on the matplotlib `download
-<http://sourceforge.net/projects/matplotlib/files/>`_ page. Click on
+<https://github.com/matplotlib/matplotlib/downloads/>`_ page. Click on
the latest release of the "matplotlib" package, choose your python
version (2.6, 2.7 or 3.2) and your platform (macosx or win32). If you
have any problems, please check the :ref:`installing-faq`, search
@@ -119,13 +118,13 @@ subdirectory.
Installing from source
======================
-If you are interested in contributing to matplotlib
-development, running the latest source code, or just like to
-build everything yourself, it is not difficult to build matplotlib
-from source. Grab the latest *tar.gz* release file from `sourceforge
-<http://sourceforge.net/project/showfiles.php?group_id=80706>`_, or if
-you want to develop matplotlib or just need the latest bugfixed
-version, grab the latest git version :ref:`install-from-git`.
+If you are interested in contributing to matplotlib development,
+running the latest source code, or just like to build everything
+yourself, it is not difficult to build matplotlib from source. Grab
+the latest *tar.gz* release file from `the download page
+<https://github.com/matplotlib/matplotlib/downloads>`_, or if you want
+to develop matplotlib or just need the latest bugfixed version, grab
+the latest git version :ref:`install-from-git`.
Once you have satisfied the requirements detailed below (mainly
python, numpy, libpng and freetype), you can build matplotlib::
@@ -157,11 +156,12 @@ Build requirements
These are external packages which you will need to install before
installing matplotlib. Windows users only need the first two (python
and numpy) since the others are built into the matplotlib Windows
-installers available for download at the sourceforge site. If you are
+installers available for download at `the download page
+<https://github.com/matplotlib/matplotlib/downloads>_`. If you are
building on OSX, see :ref:`build_osx`. If you are installing
-dependencies with a package manager on Linux, you may need to install the
-development packages (look for a "-dev" postfix) in addition to the
-libraries themselves.
+dependencies with a package manager on Linux, you may need to install
+the development packages (look for a "-dev" postfix) in addition to
+the libraries themselves.
.. note::
@@ -179,12 +179,11 @@ libraries themselves.
This does not build matplotlib, but it does get the install the
build dependencies, which will make building from source easier.
-:term:`python` 2.6 (or later but not python3)
- matplotlib requires python 2.6 or later (`download <http://www.python.org/download/>`__)
+:term:`python` 2.6, 2.7, 3.1 or 3.2
+ `Download python <http://www.python.org/download/>`_.
:term:`numpy` |minimum_numpy_version| (or later)
- array support for python (`download
- <http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103>`__)
+ array support for python (`download <http://numpy.org>`_)
libpng 1.2 (or later)
library for loading and saving :term:`PNG` files (`download
View
@@ -1,51 +1,9 @@
-matplotlib for MacOS X 10.3.9 or later and Python 2.5 and Python 2.6
-
matplotlib is a python 2D plotting library which produces publication
quality figures in a variety of hardcopy formats and interactive
environments across platforms. matplotlib can be used in python
scripts, the python and ipython shell (ala matlab or mathematica), web
application servers, and various graphical user interface toolkits.
-Home page: <http://matplotlib.sourceforge.net/>
-
-Before running matplotlib, you must install numpy. Binary installers
-for all these packages are available here:
-
- <http://pythonmac.org/packages/py25-fat/index.html>.
-
-*** Setup from source using Pip ***
-
-::
-
- pip install -e https://github.com/matplotlib/matplotlib.git#egg=Package
-
-*** Back Ends ***
-
-You may use TkAgg or WXAgg back ends; Qt and GTK support is not
-provided in this package. By default this matplotlib uses TkAgg
-because Tcl/Tk is included with MacOS X.
-
-If you wish to use WXAgg then:
-* Install wxPython from:
- <http://pythonmac.org/packages/py25-fat/index.html>.
-* Configure a matplotlibrc file, as described below.
-
-For TkAgg you may use Apple's built-in Tcl/Tk or install your own 8.4.x
-
-*** Configuring a matplotlibrc file ***
-
-If you wish to change any matplotlib settings, create a file:
- ~/.matplotlib/matplotlibrc
-
-
-that contains at least the following information. The values shown are
-the defaults in the internal matplotlibrc file; change them as you see
-fit:
-
-# the default backend; one of GTK GTKAgg GTKCairo FltkAgg QtAgg TkAgg WXAgg
-# Agg Cairo GD GDK Paint PS PDF SVG Template
-backend : TkAgg
-interactive : False # see http://matplotlib.sourceforge.net/interactive.html
+Home page: <http://matplotlib.org/>
-See also
-<http://matplotlib.sourceforge.net/users/customizing.html>
+For installation instructions and requirements, see the INSTALL file.
@@ -102,8 +102,8 @@
<h1>Download</h1>
- Matplotlib 1.1.1 is available for
-<a href="https://sourceforge.net/projects/matplotlib/files/matplotlib/matplotlib-1.1.1/">download</a>.
+ Matplotlib is available for
+<a href="https://github.com/matplotlib/matplotlib/downloads">download</a>.
<h1>Documentation</h1>
@@ -173,7 +173,9 @@
<p>Please
consider <a href="http://sourceforge.net/project/project_donations.php?group_id=80706">donating</a>
-to support matplotlib development.</p>
+to support matplotlib development or to
+the <a href="http://numfocus.org/johnhunter/">John Hunter Memorial
+Fund</a>.</p>
<p>The matplotlib <a href="{{ pathto('users/license') }}">license</a>
is based on the Python Software Foundation
View
@@ -323,16 +323,16 @@ Writing examples
================
We have hundreds of examples in subdirectories of
-:file:`matplotlib/examples`, and these are automatically
-generated when the website is built to show up both in the `examples
-<http://matplotlib.sourceforge.net/examples/index.html>`_ and `gallery
-<http://matplotlib.sourceforge.net/gallery.html>`_ sections of the
-website. Many people find these examples from the website, and do not
-have ready access to the file:`examples` directory in which they
-reside. Thus any example data that is required for the example should
-be added to the `sample_data
-<https://github.com/matplotlib/sample_data>`_ git repository.
-Then in your example code you can load it into a file handle with::
+:file:`matplotlib/examples`, and these are automatically generated
+when the website is built to show up both in the `examples
+<http://matplotlib.org/examples/index.html>`_ and `gallery
+<http://matplotlib.org/gallery.html>`_ sections of the website. Many
+people find these examples from the website, and do not have ready
+access to the file:`examples` directory in which they reside. Thus
+any example data that is required for the example should be added to
+the `sample_data <https://github.com/matplotlib/sample_data>`_ git
+repository. Then in your example code you can load it into a file
+handle with::
import matplotlib.cbook as cbook
fh = cbook.get_sample_data('mydata.dat')
@@ -351,11 +351,11 @@ object::
Writing a new pyplot function
=============================
-A large portion of the pyplot interface is automatically generated by the
+A large portion of the pyplot interface is automatically generated by the
`boilerplate.py` script (in the root of the source tree). To add or remove
a plotting method from pyplot, edit the appropriate list in `boilerplate.py`
-and then run the script which will update the content in
-`lib/matplotlib/pyplot.py`. Both the changes in `boilerplate.py` and
+and then run the script which will update the content in
+`lib/matplotlib/pyplot.py`. Both the changes in `boilerplate.py` and
`lib/matplotlib/pyplot.py` should be checked into the repository.
Testing
@@ -1,5 +1,5 @@
.. matplotlib
-.. _matplotlib: http://matplotlib.sourceforge.net
+.. _matplotlib: http://matplotlib.org
.. _`matplotlib github`: http://github.com/matplotlib/matplotlib
.. _`matplotlib mailing list`: https://lists.sourceforge.net/lists/listinfo/matplotlib-devel
@@ -93,61 +93,12 @@ Packaging
.. _release-candidate-testing:
-Release candidate testing:
-============================
-
-Post the release candidates to
-http://matplotlib.sf.net/release-candidates and post a message to
-matplotlib-users and devel requesting testing. To post to the server,
-you can do::
-
- > scp somefile.tgz jdh2358,matplotlib@shell.sf.net:/home/groups/m/ma/matplotlib/htdocs/release-candidates/
-
-replacing 'jdh2358' with your sourceforge login.
-
-
-Any changes to fix bugs in the release candidate should be fixed in
-the release branch and merged into the trunk.
-
-
-.. _release-uploading:
-
-Uploading
-=========
-
-* Post the win32 and OS-X binaries for testing and make a request on
- matplotlib-devel for testing. Pester us if we don't respond
-
-
-* ftp the source and binaries to the anonymous FTP site::
-
- mpl> git clean
- mpl> python setup.py sdist
- mpl> cd dist/
- dist> sftp jdh2358@frs.sourceforge.net
- Connecting to frs.sourceforge.net...
- sftp> cd uploads
- sftp> ls
- sftp> lls
- matplotlib-0.98.2.tar.gz
- sftp> put matplotlib-0.98.2.tar.gz
- Uploading matplotlib-0.98.2.tar.gz to /incoming/j/jd/jdh2358/uploads/matplotlib-0.98.2.tar.gz
-
-* go https://sourceforge.net/project/admin/explorer.php?group_id=80706 and do a
- file release. Click on the "Admin" tab to log in as an admin, and
- then the "File Releases" tab. Go to the bottom and click "add
- release" and enter the package name but not the version number in
- the "Package Name" box. You will then be prompted for the "New
- release name" at which point you can add the version number, eg
- somepackage-0.1 and click "Create this release".
-
- You will then be taken to a fairly self explanatory page where you
- can enter the Change notes, the release notes, and select which
- packages from the incoming ftp archive you want to include in this
- release. For each binary, you will need to select the platform and
- file type, and when you are done you click on the "notify users who
- are monitoring this package link"
+Release candidate testing
+Post the release candidates tarballs to the `matplotlib download page
+<https://github.com/matplotlib/matplotlib/downloads>`_. If you have
+developer rights, you should see and "Upload a new file" section
+there.
.. _release-announcing:
View
@@ -248,11 +248,11 @@ can try::
> easy_install matplotlib
-which should grab the latest egg from the sourceforge site, but sometimes
-the naming conventions for OSX eggs can be broken (see below).
-Therefore, there is no guarantee the right egg will be found. We recommend
-you download the latest egg from our `download site
-<http://sourceforge.net/projects/matplotlib/files/>`_ directly to your
+which should grab the latest egg from github, but sometimes the naming
+conventions for OSX eggs can be broken (see below). Therefore, there
+is no guarantee the right egg will be found. We recommend you download
+the latest egg from our `download site
+<https://github.com/matplotlib/matplotlib/downloads>`_ directly to your
harddrive, and manually install it, eg::
> easy_install --install-dir=~/dev/lib/python2.5/site-packages/ matplotlib-0.99.0.rc1-py2.5-macosx-10.5-i386.egg
@@ -349,13 +349,11 @@ Binary installers for Windows
If you have already installed python, you can use one of the
matplotlib binary installers for windows -- you can get these from the
-`sourceforge download
-<http://sourceforge.net/project/platformdownload.php?group_id=80706>`_
-site. Choose the files that match your version of python (eg
-``py2.5`` if you installed Python 2.5) which have the ``exe``
-extension. If you haven't already installed python, you can get the
-official version from the `python web site
-<http://python.org/download/>`_.
+`download <https://github.com/matplotlib/matplotlib/downloads>`_ site.
+Choose the files that match your version of python (eg ``py2.5`` if
+you installed Python 2.5) which have the ``exe`` extension. If you
+haven't already installed python, you can get the official version
+from the `python web site <http://python.org/download/>`_.
There are also two packaged distributions of python that come
preloaded with matplotlib and many other tools like ipython, numpy,
View
@@ -8,8 +8,3 @@ tex_demo.py and tex_unicode_demo.py:
plotmap.py:
basemap toolkit
-
- some data files - do a svn co
- https://matplotlib.svn.sourceforge.net/svnroot/matplotlib/trunk/htdocs/screenshots/data/
- to get the data and then set the datadir variable in the
- plotmap.py file to point to this data direcotry
@@ -226,7 +226,9 @@ object:
imgplot = plt.imshow(lum_img)
imgplot.set_cmap('spectral')
-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>`_.
+There are many other colormap schemes available. See the `list and
+images of the colormaps
+<http://matplotlib.org/examples/pylab_examples/show_colormaps.html>`_.
.. _`Color Bars`:
@@ -123,7 +123,7 @@ Multicolumn Legend
By specifying the keyword argument *ncol*, you can have a multi-column
legend. Also, mode="expand" horizontally expand the legend to fill the
axes area. See `legend_demo3.py
-<http://matplotlib.sourceforge.net/examples/pylab_examples/legend_demo3.html>`_
+<http://matplotlib.org/examples/pylab_examples/legend_demo3.html>`_
for example.
View
@@ -5,7 +5,7 @@ What's new in matplotlib
************************
This page just covers the highlights -- for the full story, see the
-`CHANGELOG <http://matplotlib.sourceforge.net/_static/CHANGELOG>`_
+`CHANGELOG <http://matplotlib.org/_static/CHANGELOG>`_
.. note::
Matplotlib version 1.1 is the last major release compatible with Python
View
@@ -5,23 +5,15 @@ These examples use the matplotlib api rather than the pylab/pyplot
procedural state machine. For robust, production level scripts, or
for applications or web application servers, we recommend you use the
matplotlib API directly as it gives you the maximum control over your
-figures, axes and plottng commands. There are a few documentation
-resources for the API
-
- - the matplotlib artist tutorial :
- http://matplotlib.sourceforge.net/pycon/artist_api_tut.pdf
-
- - the "leftwich tutorial" :
- http://matplotlib.sourceforge.net/leftwich_tut.txt
-
- The example agg_oo.py is the simplest example of using the Agg
- backend which is readily ported to other output formats. This
- example is a good starting point if your are a web application
- developer. Many of the other examples in this directory use
- matplotlib.pyplot just to create the figure and show calls, and use
- the API for everything else. This is a good solution for production
- quality scripts. For full fledged GUI applications, see the
- user_interfaces examples.
+figures, axes and plottng commands.
+
+The example agg_oo.py is the simplest example of using the Agg backend
+which is readily ported to other output formats. This example is a
+good starting point if your are a web application developer. Many of
+the other examples in this directory use matplotlib.pyplot just to
+create the figure and show calls, and use the API for everything else.
+This is a good solution for production quality scripts. For full
+fledged GUI applications, see the user_interfaces examples.
Example style guide
===================
Oops, something went wrong.

0 comments on commit ede1640

Please sign in to comment.