You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+43-28Lines changed: 43 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,10 @@ An `object-oriented <https://matplotlib.org/api/api_overview.html>`__ `matplotli
11
11
that provides versatile plotting utilities
12
12
for making beautiful, publication-quality graphics.
13
13
14
+
Documentation
15
+
-------------
16
+
The documentation is published `here <https://lukelbd.github.io/proplot>`_.
17
+
14
18
Installation
15
19
------------
16
20
@@ -23,10 +27,6 @@ on PyPi. However, feel free to install directly from Github using:
23
27
24
28
The dependencies are `matplotlib <https://matplotlib.org/>`_ and `numpy <http://www.numpy.org/>`_. The optional geographic mapping features require `cartopy <https://scitools.org.uk/cartopy/docs/latest/>`_ and/or `basemap <https://matplotlib.org/basemap/index.html>`_.
25
29
26
-
Documentation
27
-
-------------
28
-
The documentation is published `here <https://lukelbd.github.io/proplot>`_.
29
-
30
30
Overview
31
31
--------
32
32
@@ -39,24 +39,32 @@ Import with
39
39
Most of the features derive from the `~proplot.subplots.subplots` command, inspired
40
40
by the pyplot `~matplotlib.pyplot.subplots` command.
41
41
42
-
The next most important utility is the `~proplot.axes.BaseAxes.format` method, available
43
-
on every axes generated by `~proplot.subplots.subplots`. Use this method to fine-tune
44
-
your axis properties, titles, labels, limits, and much more.
42
+
The next most important utility is the `~proplot.axes.BaseAxes.format` method, available on every axes generated by `~proplot.subplots.subplots`. Use this method to fine-tune your axis properties, titles, labels, limits, and much more.
45
43
46
44
Here are some highlights of the rest of the features:
47
45
48
-
- Colors: Perceptually distinct named colors, powerful
49
-
colormap-generating tools, ability to trivially swap between "color
50
-
cycles" and "colormaps". A few new, beautiful colormaps and color
51
-
cycles. Make colorbars from lists of lines or colors.
52
-
- Geometry: A smarter "tight subplots" method. Panels and empty spaces
53
-
are held *fixed*, while the figure and axes dimensions are allowed to
54
-
change. This achieves a "tight border" without messing up axes aspect
55
-
ratios or spaces.
56
-
- Projections: Integration with basemap and cartopy. Generate arbitrary
46
+
* A smarter "tight layout" feature. Figure width or height alternately
47
+
scales so that subplot **aspect ratios** are fixed, inner space
48
+
between subplots automatically scaled so subplot tick labels, etc. do
49
+
not overlap with each other.
50
+
* Easy setting customization with a user ``.proplotrc`` file. Option
51
+
to save custom colormaps, and they will be loaded every time on startup.
52
+
* Axes panels and figure panels, for global colorbars, global legends,
53
+
or tertiary data. Panel widths always held fixed during "tight layout"
54
+
scaling.
55
+
* Perceptually distinct named colors with easy-to-remember names,
56
+
a ton of beautiful new colormaps, new property cycle colors.
57
+
* Tool for making new make new merged colormaps and "perceptually
58
+
uniform colormaps" on-the-fly.
59
+
* Making colorbars from lists of lines
60
+
or colors, making axes "inset" colorbars.
61
+
* Integration with basemap and cartopy. Generate arbitrary
57
62
grids of map projections in one go. Switch between the cartopy and
58
-
basemap backends painlessly. Add geographical features as part of the
59
-
`~proplot.axes.CartopyAxes.format` process.
63
+
basemap backends painlessly. Using the axes methods directly for basemap
64
+
plotting, instead of the `~mpl_toolkits.basemap.Basemap` object.
65
+
* Ability to add geographical features as part of the
Copy file name to clipboardExpand all lines: docs/index.rst
+13-1Lines changed: 13 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,7 @@ ProPlot
9
9
10
10
An `object-oriented <https://matplotlib.org/api/api_overview.html>`__ `matplotlib <https://matplotlib.org/>`__ wrapper
11
11
that can help you make beautiful, publication-quality graphics.
12
+
This Github page is found `here <https://github.com/lukelbd/proplot>`__.
12
13
13
14
Installation
14
15
============
@@ -51,7 +52,8 @@ and built-in geographic projections.
51
52
The next most important utility is the ``format`` method on `~proplot.axes.BaseAxes`, which calls so-called ``smart_update`` methods on the `~proplot.axes.BaseAxes`, `~proplot.axes.XYAxes`, `~proplot.axes.CartopyAxes`, and `~proplot.axes.BasemapAxes` axes types. The latter three types can all be returned by `~proplot.subplots.subplots`, depending on the arguments you used. Use `~proplot.axes.BaseAxes.format` to fine-tune your axis properties, titles, labels, limits, and much more. See :ref:`Table of projections` for the projections available to cartopy and basemap.
52
53
53
54
To get started, check out the :ref:`Introduction`.
54
-
Hopefully, you will find this API to be **less verbose** and **more powerful** than the builtin `pyplot and object-oriented <https://matplotlib.org/api/api_overview.html>`__ matplotlib APIs.
55
+
Hopefully, you will find this API to be less verbose and
56
+
more powerful than the builtin matplotlib API.
55
57
56
58
.. This is just so top-level headers in the showcase.rst
57
59
file appear as *subsections* in the documentation to
@@ -63,6 +65,16 @@ Hopefully, you will find this API to be **less verbose** and **more powerful** t
63
65
:show-inheritance:
64
66
Use 'sphinx-apidoc ../proplot -o .' to auto-generate modules.rst
65
67
68
+
Donations
69
+
=========
70
+
71
+
At well over 10,000 lines of code, this package took a shocking amount of time to write and to publish... so I'll just
0 commit comments