|  | 
| 1 | 1 | :orphan: | 
| 2 | 2 | 
 | 
| 3 |  | -.. title:: Matplotlib: Python plotting | 
|  | 3 | +.. title:: Matplotlib documentation | 
| 4 | 4 | 
 | 
| 5 | 5 | .. module:: matplotlib | 
| 6 | 6 | 
 | 
| 7 |  | -Matplotlib: Visualization with Python | 
| 8 |  | -------------------------------------- | 
|  | 7 | +Matplotlib documentation  | 
|  | 8 | +------------------------ | 
|  | 9 | + | 
|  | 10 | +Release: |release| | 
| 9 | 11 | 
 | 
| 10 | 12 | Matplotlib is a comprehensive library for creating static, animated, | 
| 11 | 13 | and interactive visualizations in Python. | 
| 12 | 14 | 
 | 
| 13 |  | -.. raw:: html | 
| 14 |  | - | 
| 15 |  | -   <div class="responsive_screenshots"> | 
| 16 |  | -      <a href="tutorials/introductory/sample_plots.html"> | 
| 17 |  | -         <div class="responsive_subfig"> | 
| 18 |  | -         <img align="middle" src="_images/sphx_glr_membrane_thumb.png" | 
| 19 |  | -          border="0" alt="screenshots"/> | 
| 20 |  | -         </div> | 
| 21 |  | -         <div class="responsive_subfig"> | 
| 22 |  | -         <img align="middle" src="_images/sphx_glr_histogram_thumb.png" | 
| 23 |  | -          border="0" alt="screenshots"/> | 
| 24 |  | -         </div> | 
| 25 |  | -         <div class="responsive_subfig"> | 
| 26 |  | -         <img align="middle" src="_images/sphx_glr_contour_thumb.png" | 
| 27 |  | -          border="0" alt="screenshots"/> | 
| 28 |  | -         </div> | 
| 29 |  | -         <div class="responsive_subfig"> | 
| 30 |  | -         <img align="middle" src="_images/sphx_glr_3D_thumb.png" | 
| 31 |  | -          border="0" alt="screenshots"/> | 
| 32 |  | -         </div> | 
| 33 |  | -      </a> | 
| 34 |  | -   </div> | 
| 35 |  | -   <span class="clear_screenshots"></span> | 
| 36 |  | - | 
| 37 |  | -Matplotlib makes easy things easy and hard things possible. | 
| 38 |  | - | 
| 39 |  | -.. container:: bullet-box-container | 
| 40 |  | - | 
| 41 |  | -   .. container:: bullet-box | 
| 42 |  | - | 
| 43 |  | -      Create | 
| 44 |  | - | 
| 45 |  | -      - Develop `publication quality plots`_ with just a few lines of code | 
| 46 |  | -      - Use `interactive figures`_ that can zoom, pan, update... | 
| 47 |  | - | 
| 48 |  | -      .. _publication quality plots: https://matplotlib.org/gallery/index.html | 
| 49 |  | -      .. _interactive figures: https://matplotlib.org/gallery/index.html#event-handling | 
| 50 |  | - | 
| 51 |  | -   .. container:: bullet-box | 
| 52 |  | - | 
| 53 |  | -      Customize | 
| 54 |  | - | 
| 55 |  | -      - `Take full control`_ of line styles, font properties, axes properties... | 
| 56 |  | -      - `Export and embed`_ to a number of file formats and interactive environments | 
| 57 |  | - | 
| 58 |  | -      .. _Take full control: https://matplotlib.org/tutorials/index.html#tutorials | 
| 59 |  | -      .. _Export and embed: https://matplotlib.org/api/index_backend_api.html | 
| 60 |  | - | 
| 61 |  | -   .. container:: bullet-box | 
| 62 |  | - | 
| 63 |  | -      Extend | 
| 64 |  | - | 
| 65 |  | -      - Explore tailored functionality provided by | 
| 66 |  | -        `third party packages <https://matplotlib.org/mpl-third-party/>`_ | 
| 67 |  | -      - Learn more about Matplotlib through the many | 
| 68 |  | -        :doc:`external learning resources <resources/index>` | 
| 69 |  | - | 
| 70 |  | -Documentation | 
| 71 |  | -~~~~~~~~~~~~~ | 
| 72 |  | - | 
| 73 |  | -To get started, read the :doc:`User's Guide <users/index>`. | 
| 74 |  | - | 
| 75 |  | -Trying to learn how to do a particular kind of plot?  Check out the | 
| 76 |  | -:doc:`examples gallery <gallery/index>` or the :doc:`list of plotting commands | 
| 77 |  | -<api/pyplot_summary>`. | 
| 78 |  | - | 
| 79 |  | -Join our community! | 
| 80 |  | -~~~~~~~~~~~~~~~~~~~ | 
| 81 |  | - | 
| 82 |  | -Matplotlib is a welcoming, inclusive project, and everyone within the community | 
| 83 |  | -is expected to abide by our `code of conduct | 
| 84 |  | -<https://github.com/matplotlib/matplotlib/blob/master/CODE_OF_CONDUCT.md>`_. | 
| 85 |  | - | 
| 86 |  | - | 
| 87 |  | -.. raw:: html | 
| 88 |  | - | 
| 89 |  | -    <h3>Get help</h3> | 
| 90 |  | -    <div class="box"> | 
| 91 |  | -      <div class="box-item"> | 
| 92 |  | -        <img src="_static/fa/discourse-brands.svg" alt="Discourse"> | 
| 93 |  | -        <p>Join our community at <a href="https://discourse.matplotlib.org">discourse.matplotlib.org</a> | 
| 94 |  | -        to get help, discuss contributing & development, and share your work.</p> | 
| 95 |  | -      </div> | 
| 96 |  | -      <div class="box-item"> | 
| 97 |  | -        <img src="_static/fa/question-circle-regular.svg" alt="Questions"> | 
| 98 |  | -        <p>If you have questions, be sure to check the <a href="faq/index.html">FAQ</a>, | 
| 99 |  | -        the <a href="api/index.html">API</a> docs. The full text | 
| 100 |  | -        <a href="search.html">search</a> is a good way to discover the docs including the many examples.</p> | 
| 101 |  | -      </div> | 
| 102 |  | -      <div class="box-item"> | 
| 103 |  | -        <img src="_static/fa/stack-overflow-brands.svg" alt="Stackoverflow"> | 
| 104 |  | -        <p>Check out the Matplotlib tag on <a href="https://stackoverflow.com/questions/tagged/matplotlib">stackoverflow</a>.</p> | 
| 105 |  | -      </div> | 
| 106 |  | -      <div class="box-item"> | 
| 107 |  | -        <img src="_static/fa/gitter-brands.svg" alt="Gitter"> | 
| 108 |  | -        <p>Short questions may be posted on the <a href="https://gitter.im/matplotlib/matplotlib">gitter channel</a>.</p> | 
| 109 |  | -      </div> | 
| 110 |  | -    </div> | 
| 111 |  | -    <hr class='box-sep'> | 
| 112 |  | -    <h3>News</h3> | 
| 113 |  | -    <div class="box"> | 
| 114 |  | -      <div class="box-item"> | 
| 115 |  | -        <img src="_static/fa/plus-square-regular.svg" alt="News"> | 
| 116 |  | -        <p>To keep up to date with what's going on in Matplotlib, see the | 
| 117 |  | -        <a href="users/whats_new.html">what's new</a> page or browse the | 
| 118 |  | -        <a href="https://github.com/matplotlib/matplotlib">source code</a>.  Anything that could | 
| 119 |  | -        require changes to your existing code is logged in the | 
| 120 |  | -        <a href="api/api_changes.html">API changes</a> file.</p> | 
| 121 |  | -      </div> | 
| 122 |  | -      <div class="box-item"> | 
| 123 |  | -        <img src="_static/fa/hashtag-solid.svg" alt="Social media"> | 
| 124 |  | -        <ul> | 
| 125 |  | -        <li>Tweet us at <a href="https://twitter.com/matplotlib">@matplotlib</a>!</li> | 
| 126 |  | -        <li>See cool plots on <a href="https://www.instagram.com/matplotart/">@matplotart</a> Instagram!</li> | 
| 127 |  | -        <li>Check out our <a href="https://matplotlib.org/matplotblog/">Blog</a>!</li> | 
| 128 |  | -        </ul> | 
| 129 |  | -      </div> | 
| 130 |  | -    </div> | 
| 131 |  | -    <hr class='box-sep'> | 
| 132 |  | -    <h3>Development</h3> | 
| 133 |  | -    <div class="box"> | 
| 134 |  | -      <div class="box-item"> | 
| 135 |  | -        <img src="_static/fa/github-brands.svg" alt="Github"> | 
| 136 |  | -        <p>Matplotlib is hosted on <a href="https://github.com/matplotlib/matplotlib">GitHub</a>.</p> | 
| 137 |  | -        <ul> | 
| 138 |  | -        <li>File bugs and feature requests on the <a href="https://github.com/matplotlib/matplotlib/issues">issue tracker</a>.</li> | 
| 139 |  | -        <li><a href="https://github.com/matplotlib/matplotlib/pulls">Pull requests</a> are always welcome.</li> | 
| 140 |  | -        </ul> | 
| 141 |  | -        <p>It is a good idea to ping us on <a href="https://discourse.matplotlib.org">Discourse</a> as well.</p> | 
| 142 |  | -      </div> | 
| 143 |  | -      <div class="box-item"> | 
| 144 |  | -        <img src="_static/fa/envelope-regular.svg" alt="Mailing lists"> | 
| 145 |  | -        <p>Mailing lists</p> | 
| 146 |  | -        <ul> | 
| 147 |  | -        <li><a href="https://mail.python.org/mailman/listinfo/matplotlib-users">matplotlib-users</a> for usage questions</li> | 
| 148 |  | -        <li><a href="https://mail.python.org/mailman/listinfo/matplotlib-devel">matplotlib-devel</a> for development</li> | 
| 149 |  | -        <li><a href="https://mail.python.org/mailman/listinfo/matplotlib-announce">matplotlib-announce</a> for project announcements</li> | 
| 150 |  | -        </ul> | 
| 151 |  | -      </div> | 
| 152 |  | -    </div> | 
| 153 |  | - | 
| 154 |  | - | 
| 155 |  | -Toolkits | 
| 156 |  | -======== | 
| 157 |  | - | 
| 158 |  | -Matplotlib ships with several add-on :doc:`toolkits <api/toolkits/index>`, | 
| 159 |  | -including 3D plotting with `.mplot3d`, axes helpers in `.axes_grid1` and axis | 
| 160 |  | -helpers in `.axisartist`. | 
| 161 |  | - | 
| 162 |  | -Third party packages | 
| 163 |  | -==================== | 
| 164 |  | - | 
| 165 |  | -A large number of  | 
| 166 |  | -`third party packages <https://matplotlib.org/mpl-third-party/>`_ | 
| 167 |  | -extend and build on Matplotlib functionality, including several higher-level | 
| 168 |  | -plotting interfaces (seaborn_, HoloViews_, ggplot_, ...), and a projection | 
| 169 |  | -and mapping toolkit (Cartopy_). | 
| 170 |  | - | 
| 171 |  | -.. _seaborn: https://seaborn.pydata.org | 
| 172 |  | -.. _HoloViews: https://holoviews.org | 
| 173 |  | -.. _ggplot: https://yhat.github.io/ggpy/ | 
| 174 |  | -.. _Cartopy: https://scitools.org.uk/cartopy/docs/latest/ | 
| 175 |  | - | 
| 176 |  | -Citing Matplotlib | 
| 177 |  | -================= | 
| 178 |  | - | 
| 179 |  | -Matplotlib is the brainchild of John Hunter (1968-2012), who, along with its | 
| 180 |  | -many contributors, have put an immeasurable amount of time and effort into | 
| 181 |  | -producing a piece of software utilized by thousands of scientists worldwide. | 
| 182 |  | - | 
| 183 |  | -If Matplotlib contributes to a project that leads to a scientific publication, | 
| 184 |  | -please acknowledge this work by citing the project. A :doc:`ready-made citation | 
| 185 |  | -entry <citing>` is available. | 
| 186 |  | - | 
| 187 |  | -Open source | 
| 188 |  | -=========== | 
| 189 |  | - | 
| 190 |  | -.. raw:: html | 
| 191 |  | - | 
| 192 |  | -   <a href="https://numfocus.org/"> | 
| 193 |  | -   <img src="_static/numfocus_badge.png" | 
| 194 |  | -    alt="A Fiscally Sponsored Project of NUMFocus" | 
| 195 |  | -    style="float:right; margin-left:20px" /> | 
| 196 |  | -   </a> | 
| 197 |  | - | 
|  | 15 | +Learn | 
|  | 16 | +===== | 
|  | 17 | +       | 
|  | 18 | +- :doc:`Quick-start Guide <tutorials/introductory/usage>` | 
|  | 19 | +- Basic :doc:`Plot Types <plot_types/index>` and :doc:`Example Gallery <gallery/index>` | 
|  | 20 | +- `Introductory Tutorials <../tutorials/index.html#introductory>`_ | 
|  | 21 | +       | 
|  | 22 | +Reference | 
|  | 23 | +========= | 
| 198 | 24 | 
 | 
| 199 |  | -Matplotlib is a Sponsored Project of NumFOCUS, a 501(c)(3) nonprofit | 
| 200 |  | -charity in the United States. NumFOCUS provides Matplotlib with | 
| 201 |  | -fiscal, legal, and administrative support to help ensure the health | 
| 202 |  | -and sustainability of the project. Visit `numfocus.org <nf_>`_ for more | 
| 203 |  | -information. | 
|  | 25 | +- :doc:`API Reference <api/index>` | 
| 204 | 26 | 
 | 
| 205 |  | -Donations to Matplotlib are managed by NumFOCUS. For donors in the | 
| 206 |  | -United States, your gift is tax-deductible to the extent provided by | 
| 207 |  | -law. As with any donation, you should consult with your tax adviser | 
| 208 |  | -about your particular tax situation. | 
|  | 27 | +  - :doc:`pyplot API <api/pyplot_summary>`: top-level interface to create  | 
|  | 28 | +    Figures (`.pyplot.figure`) and Subplots (`.pyplot.subplots`,  | 
|  | 29 | +    `.pyplot.subplot_mosaic`) | 
|  | 30 | +  - :doc:`Axes API <api/axes_api>` for *most* plotting methods | 
|  | 31 | +  - :doc:`Figure API <api/figure_api>` for figure-level methods | 
| 209 | 32 | 
 | 
| 210 |  | -Please consider `donating to the Matplotlib project <donating_>`_ through | 
| 211 |  | -the NumFOCUS organization or to the `John Hunter Technology Fellowship | 
| 212 |  | -<jdh-fellowship_>`_. | 
|  | 33 | +- :doc:`Extra Toolkits <api/toolkits/index>` | 
| 213 | 34 | 
 | 
| 214 |  | -.. _donating: https://numfocus.org/donate-to-matplotlib | 
| 215 |  | -.. _jdh-fellowship: https://numfocus.org/programs/john-hunter-technology-fellowship/ | 
| 216 |  | -.. _nf: https://numfocus.org | 
|  | 35 | +How-tos | 
|  | 36 | +======= | 
| 217 | 37 | 
 | 
| 218 |  | -The :doc:`Matplotlib license <users/license>` is based on the `Python Software | 
| 219 |  | -Foundation (PSF) license <psf-license_>`_. | 
|  | 38 | +- :doc:`Installation Guide <users/installing>` | 
|  | 39 | +- :doc:`Contributing to Matplotlib <devel/index>` | 
|  | 40 | +- :doc:`Matplotlib FAQ <faq/index>` | 
| 220 | 41 | 
 | 
| 221 |  | -.. _psf-license: https://docs.python.org/3/license.html | 
|  | 42 | +Understand how Matplotlib works | 
|  | 43 | +=============================== | 
| 222 | 44 | 
 | 
| 223 |  | -There is an active developer community and a long list of people who have made | 
| 224 |  | -significant :doc:`contributions <users/credits>`. | 
|  | 45 | +- Many of the :doc:`Tutorials <tutorials/index>` have explanatory material | 
0 commit comments