|
25 | 25 | .. |NUMFocus| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
|
26 | 26 | .. _NUMFocus: http://www.numfocus.org
|
27 | 27 |
|
| 28 | + |
28 | 29 | .. |GitTutorial| image:: https://img.shields.io/badge/PR-Welcome-%23FF8300.svg?
|
29 | 30 | .. _GitTutorial: https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project
|
30 | 31 |
|
31 |
| -########## |
32 |
| -Matplotlib |
33 |
| -########## |
| 32 | +.. image:: doc/_static/logo2.png |
34 | 33 |
|
35 |
| -Matplotlib is a Python 2D plotting library which produces publication-quality |
36 |
| -figures in a variety of hardcopy formats and interactive environments across |
37 |
| -platforms. Matplotlib can be used in Python scripts, the Python and IPython |
38 |
| -shell (à la MATLAB or Mathematica), web application servers, and various |
39 |
| -graphical user interface toolkits. |
40 | 34 |
|
41 |
| -NOTE: The current master branch is now Python 3 only. Python 2 support is |
42 |
| -being dropped. |
| 35 | +Matplotlib is a comprehensive library for creating static, animated, and interactive visualizations in Python. |
| 36 | + |
| 37 | +Check out our `home page <http://matplotlib.org/>`_ for more information. |
| 38 | + |
| 39 | +.. image:: doc/_static/readme_preview.png |
| 40 | + |
| 41 | +Matplotlib produces publication-quality figures in a variety of hardcopy formats |
| 42 | +and interactive environments across platforms. Matplotlib can be used in Python scripts, |
| 43 | +the Python and IPython shell, web application servers, and various |
| 44 | +graphical user interface toolkits. |
43 | 45 |
|
44 |
| -`Home page <http://matplotlib.org/>`_ |
45 | 46 |
|
46 | 47 | Install
|
47 | 48 | =======
|
48 | 49 |
|
49 |
| -For installation instructions and requirements, see the INSTALL.rst file or the |
50 |
| -`install <http://matplotlib.org/users/installing.html>`_ documentation. If you |
51 |
| -think you may want to contribute to matplotlib, check out the `guide to |
52 |
| -working with the source code |
53 |
| -<http://matplotlib.org/devel/gitwash/index.html>`_. |
| 50 | +For installation instructions and requirements, see `INSTALL.rst <INSTALL.rst>`_ or the |
| 51 | +`install <http://matplotlib.org/users/installing.html>`_ documentation. |
54 | 52 |
|
55 | 53 | Test
|
56 | 54 | ====
|
57 | 55 |
|
58 |
| -After installation, you can launch the test suite:: |
| 56 | +After installation, launch the test suite:: |
| 57 | + |
| 58 | + python -m pytest |
59 | 59 |
|
60 |
| - pytest |
| 60 | +Read the `testing guide <https://matplotlib.org/devel/testing.html>`_ for more information and alternatives. |
61 | 61 |
|
62 |
| -Or from the Python interpreter:: |
| 62 | +Contribute |
| 63 | +========== |
| 64 | +You've discovered a bug or something else you want to change - excellent! |
63 | 65 |
|
64 |
| - import matplotlib |
65 |
| - matplotlib.test() |
| 66 | +You've worked out a way to fix it – even better! |
66 | 67 |
|
67 |
| -Consider reading http://matplotlib.org/devel/coding_guide.html#testing for more |
68 |
| -information. Note that the test suite requires pytest. Please install with pip |
69 |
| -or your package manager of choice. |
| 68 | +You want to tell us about it – best of all! |
| 69 | + |
| 70 | +Start at the `contributing guide <http://matplotlib.org/devdocs/devel/contributing.html>`_! |
70 | 71 |
|
71 | 72 | Contact
|
72 | 73 | =======
|
73 |
| -matplotlib's communication channels include active mailing lists: |
| 74 | + |
| 75 | +`Discourse <https://discourse.matplotlib.org/>`_ is the discussion forum for general questions and discussions and our recommended starting point. |
| 76 | + |
| 77 | +Our active mailing lists (which are mirrored on Discourse) are: |
74 | 78 |
|
75 | 79 | * ` Users < https://mail.python.org/mailman/listinfo/matplotlib-users>`_ mailing list: [email protected]
|
76 | 80 | * ` Announcement < https://mail.python.org/mailman/listinfo/matplotlib-announce>`_ mailing list: [email protected]
|
77 | 81 | * ` Development < https://mail.python.org/mailman/listinfo/matplotlib-devel>`_ mailing list: [email protected]
|
78 | 82 |
|
79 |
| -The first is a good starting point for general questions and discussions. |
80 |
| - |
81 | 83 | Gitter_ is for coordinating development and asking questions directly related
|
82 | 84 | to contributing to matplotlib.
|
83 | 85 |
|
84 |
| -Contribute |
85 |
| -========== |
86 |
| -You've discovered a bug or something else you want to change - excellent! |
87 |
| - |
88 |
| -You've worked out a way to fix it – even better! |
89 |
| - |
90 |
| -You want to tell us about it – best of all! |
91 |
| - |
92 |
| -Start at the `contributing guide <http://matplotlib.org/devdocs/devel/contributing.html>`_! |
93 |
| - |
94 |
| -Developer notes are now at `Developer Discussions <https://github.com/orgs/matplotlib/teams/developers/discussions>`_ (Note: For technical reasons, this is currently only accessible for matplotlib developers.) |
95 | 86 |
|
96 | 87 | Citing Matplotlib
|
97 | 88 | =================
|
98 | 89 | If Matplotlib contributes to a project that leads to publication, please
|
99 | 90 | acknowledge this by citing Matplotlib.
|
| 91 | + |
100 | 92 | `A ready-made citation entry <https://matplotlib.org/citing.html>`_ is available.
|
0 commit comments