Skip to content

Reorganise mpl_toolkits documentation #5752

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 32 commits into from
Jan 8, 2016
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
999786f
Move axesgrid1 api docs to axesgrid1
jenshnielsen Dec 26, 2015
8f461a2
Move non bundled packages from toolkits to resources
jenshnielsen Dec 26, 2015
b72e97a
Split documentation in axisartist and axes_grid1
jenshnielsen Dec 26, 2015
786c389
Move axisartist userguide to axisartist
jenshnielsen Dec 26, 2015
e9a9cc8
Remove warning
jenshnielsen Dec 26, 2015
a8ae5aa
Split axes_grid1 and axisartist examples
jenshnielsen Dec 26, 2015
60a8b7f
Correct links to examples
jenshnielsen Dec 26, 2015
535eb24
Correct links in whatsnew
jenshnielsen Dec 26, 2015
d49bbce
Correct links to gallery
jenshnielsen Dec 26, 2015
047ccb2
Split figures in axisartist and axisgrid1
jenshnielsen Dec 26, 2015
b1798b6
Correct links to figures
jenshnielsen Dec 26, 2015
138a6c1
Move axisartist docs
jenshnielsen Dec 26, 2015
ef84b93
Move overview docs up one level
jenshnielsen Dec 26, 2015
b41caa4
Clarify index
jenshnielsen Dec 28, 2015
44fb5ea
Update axes_grid1 overview
jenshnielsen Dec 29, 2015
9862d43
Update axes_grid1 some more
jenshnielsen Dec 29, 2015
a2d8009
update axisartist
jenshnielsen Dec 29, 2015
69705a7
Copy all remaing functionality from axes_grid to axisartist
jenshnielsen Dec 29, 2015
b17e5d6
Deprecate mpl_toolkits.axes_grid
jenshnielsen Dec 29, 2015
74da787
Move third party packages to its own toplevel index
jenshnielsen Dec 29, 2015
f6a4c78
Correct module name for axisartist
jenshnielsen Dec 29, 2015
3446e2c
Correct links on front page
jenshnielsen Dec 29, 2015
dd8a782
Update examples readme
jenshnielsen Dec 29, 2015
0635dfe
Remove the use of axes_grid from plotting userguide
jenshnielsen Dec 29, 2015
3b52513
remove pre python26 workaround
jenshnielsen Dec 29, 2015
5846f77
axes_grid to axes_grid1 in whatsnew
jenshnielsen Dec 29, 2015
6e805cf
Don't mention axes_grid in the annotation guide
jenshnielsen Dec 29, 2015
969982e
Remove toc trees
jenshnielsen Dec 30, 2015
00cdd55
Add note about the Matplotlib github org
jenshnielsen Dec 30, 2015
e47e071
Correct typos found by mdboom
jenshnielsen Dec 30, 2015
e817d39
Add api changes about deprecating axes_grid
jenshnielsen Dec 30, 2015
301980c
Correct typos found by @WeatherGod
jenshnielsen Jan 5, 2016
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Move non bundled packages from toolkits to resources
  • Loading branch information
jenshnielsen committed Jan 5, 2016
commit 8f461a220ca3ee097e47e0b60617d2b9c89fce45
127 changes: 0 additions & 127 deletions doc/mpl_toolkits/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,45 +17,6 @@ Toolkits
Toolkits are collections of application-specific functions that extend matplotlib.


.. _toolkits-mapping:


Mapping Toolkits
****************


.. _toolkit_basemap:

Basemap
=======
(*Not distributed with matplotlib*)

Plots data on map projections, with continental and political
boundaries, see `basemap <http://matplotlib.org/basemap>`_
docs.

.. image:: /_static/basemap_contour1.png
:height: 400px



Cartopy
=======
(*Not distributed with matplotlib*)

An alternative mapping library written for matplotlib ``v1.2`` and beyond.
`Cartopy <http://scitools.org.uk/cartopy/docs/latest>`_ builds on top of
matplotlib to provide object oriented map projection definitions and close
integration with Shapely for powerful yet easy-to-use vector data processing
tools. An example plot from the
`Cartopy gallery <http://scitools.org.uk/cartopy/docs/latest/gallery.html>`_:

.. image:: /_static/cartopy_hurricane_katrina_01_00.png
:height: 400px


.. _toolkits-shipped:


General Toolkits
****************
Expand Down Expand Up @@ -96,17 +57,6 @@ distributed with matplotlib source.
.. image:: /_static/demo_axes_grid.png


.. _toolkit_mpldatacursor:

MplDataCursor
=============
(*Not distributed with matplotlib*)

`MplDataCursor <https://github.com/joferkington/mpldatacursor>`_ is a
toolkit written by Joe Kington to provide interactive "data cursors"
(clickable annotation boxes) for matplotlib.


.. _toolkit_gtk:

GTK Tools
Expand All @@ -125,80 +75,3 @@ Excel Tools
mpl_toolkits.exceltools provides some utilities for working with
Excel. This toolkit ships with matplotlib, but requires
`xlwt <http://pypi.python.org/pypi/xlwt>`_


.. _toolkit_natgrid:

Natgrid
=======
(*Not distributed with matplotlib*)

mpl_toolkits.natgrid is an interface to natgrid C library for gridding
irregularly spaced data. This requires a separate installation of the
`natgrid toolkit <http://github.com/matplotlib/natgrid>`__.


.. _toolkit_matplotlibvenn:

Matplotlib-Venn
===============
(*Not distributed with matplotlib*)

`Matplotlib-Venn <https://github.com/konstantint/matplotlib-venn>`_ provides a set of functions for plotting 2- and 3-set area-weighted (or unweighted) Venn diagrams.

mplstereonet
===============
(*Not distributed with matplotlib*)

`mplstereonet <https://github.com/joferkington/mplstereonet>`_ provides stereonets for plotting and analyzing orientation data in Matplotlib.


.. _hl_plotting:

High-Level Plotting
*******************

Several projects have started to provide a higher-level interface to
matplotlib. These are independent projects.

.. _toolkit_seaborn:

seaborn
=======
(*Not distributed with matplotlib*)

`seaborn <http://web.stanford.edu/~mwaskom/software/seaborn>`_ is a high
level interface for drawing statistical graphics with matplotlib. It
aims to make visualization a central part of exploring and
understanding complex datasets.

.. _toolkit_ggplot:

ggplot
======
(*Not distributed with matplotlib*)

`ggplot <https://github.com/yhat/ggplot>`_ is a port of the R ggplot2
to python based on matplotlib.


.. _toolkit_prettyplotlib:

prettyplotlib
=============
(*Not distributed with matplotlib*)

`prettyplotlib <https://olgabot.github.io/prettyplotlib>`_ is an extension
to matplotlib which changes many of the defaults to make plots some
consider more attractive.


iTerm2 terminal backend
=======================
(*Not distributed with matplotlib*)

`matplotlib_iterm2 <https://github.com/oselivanov/matplotlib_iterm2>`_ is an
external matplotlib backend uses iTerm2 nightly build inline image display
feature.

.. image:: /_static/matplotlib_iterm2_demo.png
122 changes: 122 additions & 0 deletions doc/resources/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,125 @@
* `Anatomy of Matplotlib - IPython Notebooks
<https://github.com/WeatherGod/AnatomyOfMatplotlib>`_
by Benjamin Root

=================
Related Packages
=================

Mapping Toolkits
****************


.. _toolkit_basemap:

Basemap
=======

Plots data on map projections, with continental and political
boundaries, see `basemap <http://matplotlib.org/basemap>`_
docs.

.. image:: /_static/basemap_contour1.png
:height: 400px



Cartopy
=======

An alternative mapping library written for matplotlib ``v1.2`` and beyond.
`Cartopy <http://scitools.org.uk/cartopy/docs/latest>`_ builds on top of
matplotlib to provide object oriented map projection definitions and close
integration with Shapely for powerful yet easy-to-use vector data processing
tools. An example plot from the
`Cartopy gallery <http://scitools.org.uk/cartopy/docs/latest/gallery.html>`_:

.. image:: /_static/cartopy_hurricane_katrina_01_00.png
:height: 400px


.. _toolkits-shipped:


General Toolkits
****************


.. _toolkit_mpldatacursor:

MplDataCursor
=============

`MplDataCursor <https://github.com/joferkington/mpldatacursor>`_ is a
toolkit written by Joe Kington to provide interactive "data cursors"
(clickable annotation boxes) for matplotlib.


.. _toolkit_natgrid:

Natgrid
=======

mpl_toolkits.natgrid is an interface to natgrid C library for gridding
irregularly spaced data. This requires a separate installation of the
`natgrid toolkit <http://github.com/matplotlib/natgrid>`__.


.. _toolkit_matplotlibvenn:

Matplotlib-Venn
===============

`Matplotlib-Venn <https://github.com/konstantint/matplotlib-venn>`_ provides a set of functions for plotting 2- and 3-set area-weighted (or unweighted) Venn diagrams.

mplstereonet
===============

`mplstereonet <https://github.com/joferkington/mplstereonet>`_ provides stereonets for plotting and analyzing orientation data in Matplotlib.


.. _hl_plotting:

High-Level Plotting
*******************

Several projects have started to provide a higher-level interface to
matplotlib. These are independent projects.

.. _toolkit_seaborn:

seaborn
=======

`seaborn <http://web.stanford.edu/~mwaskom/software/seaborn>`_ is a high
level interface for drawing statistical graphics with matplotlib. It
aims to make visualization a central part of exploring and
understanding complex datasets.

.. _toolkit_ggplot:

ggplot
======

`ggplot <https://github.com/yhat/ggplot>`_ is a port of the R ggplot2
to python based on matplotlib.


.. _toolkit_prettyplotlib:

prettyplotlib
=============

`prettyplotlib <https://olgabot.github.io/prettyplotlib>`_ is an extension
to matplotlib which changes many of the defaults to make plots some
consider more attractive.


iTerm2 terminal backend
=======================

`matplotlib_iterm2 <https://github.com/oselivanov/matplotlib_iterm2>`_ is an
external matplotlib backend uses iTerm2 nightly build inline image display
feature.

.. image:: /_static/matplotlib_iterm2_demo.png