Metadata-Version: 2.1
Name: mpltern
Version: 0.4.0
Summary: Ternary plots as projections of Matplotlib
Home-page: https://github.com/yuzie007/mpltern
Author: Yuji Ikeda
Author-email: yuji.ikeda.ac.jp@gmail.com
Project-URL: Bug Reports, https://github.com/yuzie007/mpltern/issues
Project-URL: Source, https://github.com/yuzie007/mpltern
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
License-File: LICENSE

######################################
mpltern: Ternary plots with Matplotlib
######################################

.. |PyPI version| image:: https://badge.fury.io/py/mpltern.svg
   :target: https://badge.fury.io/py/mpltern
.. |PyPI| image:: https://img.shields.io/pypi/dm/mpltern.svg
   :target: https://pypi.python.org/pypi/mpltern
.. |Conda Version| image:: https://img.shields.io/conda/vn/conda-forge/mpltern.svg
   :target: https://anaconda.org/conda-forge/mpltern
.. |Conda Downloads| image:: https://img.shields.io/conda/dn/conda-forge/mpltern.svg
   :target: https://anaconda.org/conda-forge/mpltern
.. |GitHubActions| image:: https://github.com/yuzie007/mpltern/actions/workflows/tests.yml/badge.svg
   :target: https://github.com/yuzie007/mpltern/actions?query=workflow%3ATests
.. |CircleCI| image:: https://circleci.com/gh/yuzie007/mpltern.svg?style=shield
   :target: https://circleci.com/gh/yuzie007/mpltern
.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3528354.svg
   :target: https://doi.org/10.5281/zenodo.3528354

|PyPI version| |PyPI| |Conda Version| |Conda Downloads|

|GitHubActions| |CircleCI|

|DOI|

Mpltern (https://yuzie007.github.io/mpltern) is a Python plotting library based
on `Matplotlib <https://matplotlib.org>`__ specifically designed
for `ternary plots <https://en.wikipedia.org/wiki/Ternary_plot>`_.
Mpltern is implemented as a new projection for Matplotlib, with introducing
e.g. new ``Transform`` classes for ternary plots.
The followings are the features of mpltern when compared with other
ternary-plot libraries:

- Many things one expects essentially possible using Matplotlib can be done
  also in mpltern, without e.g. ternary-to-Cartesian conversions on the user
  side

- For the same plotting styles, mpltern offers the same or very similar method
  names as Matplotlib does; you do not need to learn many new commands in
  addition to those for Matplotlib

- Tick markers, tick labels, and axis labels are automatically positioned with
  reasonable paddings inherited from Matplotlib;
  this allows users e.g. faster production of ternary plots with publication
  quality

- ``tight_layout`` and ``constrained_layout``

- Easy combination with normal Matplotlib plots

- Easy application of `seaborn <https://seaborn.pydata.org>`__ styles

- Working also in Matplotlib interactive modes inside e.g.
  `Jupyter <http://jupyter.org>`__ notebooks

.. list-table::
   :widths: auto

   * - .. image:: https://mpltern.readthedocs.io/en/latest/_images/sphx_glr_with_seaborn_styles_001.svg
          :target: https://mpltern.readthedocs.io/en/latest/gallery/intermediate/with_seaborn_styles.html
     - .. image:: https://mpltern.readthedocs.io/en/latest/_images/sphx_glr_05.inset_001.svg
          :target: https://mpltern.readthedocs.io/en/latest/gallery/advanced/05.inset.html
     - .. image:: https://mpltern.readthedocs.io/en/latest/_images/sphx_glr_07.polygon_001.svg
          :target: https://mpltern.readthedocs.io/en/latest/gallery/introductory/07.polygon.html
     - .. image:: https://mpltern.readthedocs.io/en/latest/_images/sphx_glr_02.arbitrary_triangle_001.svg
          :target: https://mpltern.readthedocs.io/en/latest/gallery/triangle/02.arbitrary_triangle.html

.. list-table::
   :widths: auto

   * - .. image:: https://mpltern.readthedocs.io/en/latest/_images/sphx_glr_01.scatter_001.svg
          :target: https://mpltern.readthedocs.io/en/latest/gallery/introductory/01.scatter.html
     - .. image:: https://mpltern.readthedocs.io/en/latest/_images/sphx_glr_08.quiver_001.svg
          :target: https://mpltern.readthedocs.io/en/latest/gallery/introductory/08.quiver.html

.. list-table::
   :widths: auto

   * - .. image:: https://mpltern.readthedocs.io/en/latest/_images/sphx_glr_02.contour_001.svg
          :target: https://mpltern.readthedocs.io/en/latest/gallery/introductory/02.contour.html
     - .. image:: https://mpltern.readthedocs.io/en/latest/_images/sphx_glr_03.pseudocolor_001.svg
          :target: https://mpltern.readthedocs.io/en/latest/gallery/introductory/03.pseudocolor.html

Installation
============

See the `install
documentation <https://mpltern.readthedocs.io/en/latest/installation.html>`__.

Basic Usage
===========

See the `basic usage
documentation <https://mpltern.readthedocs.io/en/latest/basic_usage.html>`__.

See `more examples in the gallery
<https://mpltern.readthedocs.io/en/latest/gallery/index.html>`__.

How to Cite mpltern
===================

The author requests to cite mpltern via the DOI above if mpltern contributes
to a scientific publication.
Of course, `Matplotlib should be also very much acknowledged <https://matplotlib.org/citing.html>`_
when using mpltern.

Author
======

Yuji Ikeda
(`GitHub <https://github.com/yuzie007>`__,
`Google Scholar <https://scholar.google.co.jp/citations?user=2m5dkBwAAAAJ&hl=en>`__,
`ResearchGate <https://www.researchgate.net/profile/Yuji_Ikeda6>`__)
