|
| 1 | +[](https://badge.fury.io/py/matplotlib) |
| 2 | +[](https://pepy.tech/project/matplotlib) |
| 3 | +[](https://numfocus.org) |
| 4 | + |
| 5 | +[](https://discourse.matplotlib.org) |
| 6 | +[](https://gitter.im/matplotlib/matplotlib) |
| 7 | +[](https://github.com/matplotlib/matplotlib/issues) |
| 8 | +[](https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project) |
| 9 | + |
| 10 | +[](https://github.com/matplotlib/matplotlib/actions?query=workflow%3ATests) |
| 11 | +[](https://dev.azure.com/matplotlib/matplotlib/_build/latest?definitionId=1&branchName=main) |
| 12 | +[](https://ci.appveyor.com/project/matplotlib/matplotlib) |
| 13 | +[](https://codecov.io/github/matplotlib/matplotlib?branch=main) |
| 14 | +[](https://lgtm.com/projects/g/matplotlib/matplotlib) |
| 15 | + |
| 16 | + |
| 17 | + |
| 18 | +Matplotlib is a comprehensive library for creating static, animated, and |
| 19 | +interactive visualizations in Python. |
| 20 | + |
| 21 | +Check out our [home page](https://matplotlib.org/) for more information. |
| 22 | + |
| 23 | + |
| 24 | + |
| 25 | +Matplotlib produces publication-quality figures in a variety of hardcopy |
| 26 | +formats and interactive environments across platforms. Matplotlib can be |
| 27 | +used in Python scripts, Python/IPython shells, web application servers, |
| 28 | +and various graphical user interface toolkits. |
| 29 | + |
| 30 | +## Install |
| 31 | + |
| 32 | +See the [install |
| 33 | +documentation](https://matplotlib.org/stable/users/installing/index.html), |
| 34 | +which is generated from `/doc/users/installing/index.rst` |
| 35 | + |
| 36 | +## Contribute |
| 37 | + |
| 38 | +You've discovered a bug or something else you want to change - |
| 39 | +excellent! |
| 40 | + |
| 41 | +You've worked out a way to fix it -- even better! |
| 42 | + |
| 43 | +You want to tell us about it -- best of all! |
| 44 | + |
| 45 | +Start at the [contributing |
| 46 | +guide](https://matplotlib.org/devdocs/devel/contributing.html)! |
| 47 | + |
| 48 | +## Contact |
| 49 | + |
| 50 | +[Discourse](https://discourse.matplotlib.org/) is the discussion forum |
| 51 | +for general questions and discussions and our recommended starting |
| 52 | +point. |
| 53 | + |
| 54 | +Our active mailing lists (which are mirrored on Discourse) are: |
| 55 | + |
| 56 | +- [Users](https://mail.python.org/mailman/listinfo/matplotlib-users) |
| 57 | + mailing list: <matplotlib-users@python.org> |
| 58 | +- [Announcement](https://mail.python.org/mailman/listinfo/matplotlib-announce) |
| 59 | + mailing list: <matplotlib-announce@python.org> |
| 60 | +- [Development](https://mail.python.org/mailman/listinfo/matplotlib-devel) |
| 61 | + mailing list: <matplotlib-devel@python.org> |
| 62 | + |
| 63 | +[Gitter](https://gitter.im/matplotlib/matplotlib) is for coordinating |
| 64 | +development and asking questions directly related to contributing to |
| 65 | +matplotlib. |
| 66 | + |
| 67 | +## Citing Matplotlib |
| 68 | + |
| 69 | +If Matplotlib contributes to a project that leads to publication, please |
| 70 | +acknowledge this by citing Matplotlib. |
| 71 | + |
| 72 | +[A ready-made citation |
| 73 | +entry](https://matplotlib.org/stable/users/project/citing.html) is |
| 74 | +available. |
| 75 | + |
| 76 | +### Research notice |
| 77 | + |
| 78 | +Please note that this repository is participating in a study into |
| 79 | +sustainability of open source projects. Data will be gathered about this |
| 80 | +repository for approximately the next 12 months, starting from June |
| 81 | +2021. |
| 82 | + |
| 83 | +Data collected will include number of contributors, number of PRs, time |
| 84 | +taken to close/merge these PRs, and issues closed. |
| 85 | + |
| 86 | +For more information, please visit [the informational |
| 87 | +page](https://sustainable-open-science-and-software.github.io/) or |
| 88 | +download the [participant information |
| 89 | +sheet](https://sustainable-open-science-and-software.github.io/assets/PIS_sustainable_software.pdf). |
0 commit comments