README.rst 3.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. |Travis|_ |AppVeyor|_ |Codecov|_ |PyPi|_ |Gitter|_ |NUMFocus|_
  2. .. |Travis| image:: https://travis-ci.org/matplotlib/matplotlib.svg?branch=master
  3. .. _Travis: https://travis-ci.org/matplotlib/matplotlib
  4. .. |AppVeyor| image:: https://ci.appveyor.com/api/projects/status/github/matplotlib/matplotlib?branch=master&svg=true
  5. .. _AppVeyor: https://ci.appveyor.com/project/matplotlib/matplotlib
  6. .. |Codecov| image:: https://codecov.io/github/matplotlib/matplotlib/badge.svg?branch=master&service=github
  7. .. _Codecov: https://codecov.io/github/matplotlib/matplotlib?branch=master
  8. .. |PyPi| image:: https://badge.fury.io/py/matplotlib.svg
  9. .. _PyPi: https://badge.fury.io/py/matplotlib
  10. .. |Gitter| image:: https://badges.gitter.im/matplotlib/matplotlib.png
  11. .. _Gitter: https://gitter.im/matplotlib/matplotlib
  12. .. |NUMFocus| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
  13. .. _NUMFocus: http://www.numfocus.org
  14. ##########
  15. Matplotlib
  16. ##########
  17. Matplotlib is a Python 2D plotting library which produces publication-quality
  18. figures in a variety of hardcopy formats and interactive environments across
  19. platforms. Matplotlib can be used in Python scripts, the Python and IPython
  20. shell (à la MATLAB or Mathematica), web application servers, and various
  21. graphical user interface toolkits.
  22. `Home page <http://matplotlib.org/>`_
  23. Installation
  24. ============
  25. For installation instructions and requirements, see the INSTALL.rst file or the
  26. `install <http://matplotlib.org/users/installing.html>`_ documentation. If you
  27. think you may want to contribute to matplotlib, check out the `guide to
  28. working with the source code
  29. <http://matplotlib.org/devel/gitwash/index.html>`_.
  30. Testing
  31. =======
  32. After installation, you can launch the test suite::
  33. py.test
  34. Or from the Python interpreter::
  35. import matplotlib
  36. matplotlib.test()
  37. Consider reading http://matplotlib.org/devel/coding_guide.html#testing for
  38. more information. Note that the test suite requires pytest and, on Python 2.7,
  39. mock. Please install with pip or your package manager of choice.
  40. Contact
  41. =======
  42. matplotlib's communication channels include active mailing lists:
  43. * `Users <https://mail.python.org/mailman/listinfo/matplotlib-users>`_ mailing list: matplotlib-users@python.org
  44. * `Announcement <https://mail.python.org/mailman/listinfo/matplotlib-announce>`_ mailing list: matplotlib-announce@python.org
  45. * `Development <https://mail.python.org/mailman/listinfo/matplotlib-devel>`_ mailing list: matplotlib-devel@python.org
  46. The first is a good starting point for general questions and discussions.
  47. Gitter_ is for coordinating development and asking questions directly related
  48. to contributing to matplotlib.
  49. Contribute
  50. ==========
  51. You've discovered a bug or something else you want to change - excellent!
  52. You've worked out a way to fix it – even better!
  53. You want to tell us about it – best of all!
  54. Start at the `contributing guide <http://matplotlib.org/devdocs/devel/contributing.html>`_!
  55. Developer notes are now at `_Developer Discussions <https://github.com/orgs/matplotlib/teams/developers/discussions>`_