mpltern 1.0.4
Ternary plots as projections of Matplotlib
Requires Python: >=3.7

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

.. |PyPI version| image:: https://badge.fury.io/py/mpltern.svg
   :target: https://badge.fury.io/py/mpltern
.. |Downloads| image:: https://static.pepy.tech/badge/mpltern/month
   :target: https://pepy.tech/project/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
.. |Codecov| image:: https://codecov.io/gh/yuzie007/mpltern/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/yuzie007/mpltern

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

|GitHubActions| |CircleCI| |Codecov|

|DOI|

.. _Matplotlib: https://matplotlib.org

`Mpltern <https://yuzie007.github.io/mpltern>`__ is a Python plotting library
based on `Matplotlib`_ specifically designed for
`ternary plots <https://en.wikipedia.org/wiki/Ternary_plot>`__.

- Direct dependence on `Matplotlib`_ only

- `Compatible with multiple Matplotlib versions with a high test coverage
  <https://app.codecov.io/gh/yuzie007/mpltern>`__

- `Many plotting styles with similar method names to those in Matplotlib
  <https://mpltern.readthedocs.io/en/latest/gallery/introductory/index.html>`__

- `Automatic positioning of tick markers, tick labels, and axis labels
  consistent with Matplotlib
  <https://mpltern.readthedocs.io/en/latest/gallery/axis_and_tick/index.html>`__

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

- `Easy combination with normal Matplotlib plots
  <https://mpltern.readthedocs.io/en/latest/gallery/intermediate/00.with_normal_plots.html>`__

- `Easy application of style sheets
  <https://mpltern.readthedocs.io/en/latest/gallery/intermediate/01.style_sheets.html>`__

- Interactive in, e.g., `Jupyter <http://jupyter.org>`__ notebooks

.. list-table::
   :widths: auto

   * - .. image:: https://mpltern.readthedocs.io/en/latest/_images/sphx_glr_01.style_sheets_001.svg
          :target: https://mpltern.readthedocs.io/en/latest/gallery/intermediate/01.style_sheets.html
     - .. image:: https://mpltern.readthedocs.io/en/latest/_images/sphx_glr_01.hexagonal_limits_001.svg
          :target: https://mpltern.readthedocs.io/en/latest/gallery/limits/01.hexagonal_limits.html
     - .. image:: https://mpltern.readthedocs.io/en/latest/_images/sphx_glr_soil_texture_001.svg
          :target: https://mpltern.readthedocs.io/en/latest/gallery/miscellaneous/soil_texture.html
   * - .. image:: https://mpltern.readthedocs.io/en/latest/_images/sphx_glr_98.colored_axes_001.svg
          :target: https://mpltern.readthedocs.io/en/latest/gallery/axis_and_tick/98.colored_axes.html
     - .. image:: https://mpltern.readthedocs.io/en/latest/_images/sphx_glr_21.tick-locators_001.svg
          :target: https://mpltern.readthedocs.io/en/latest/gallery/axis_and_tick/21.tick-locators.html
     - .. image:: https://mpltern.readthedocs.io/en/latest/_images/sphx_glr_evolutionary_game_theory_001.svg
          :target: https://mpltern.readthedocs.io/en/latest/gallery/miscellaneous/evolutionary_game_theory.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
   * - .. 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
   * - .. image:: https://mpltern.readthedocs.io/en/latest/_images/sphx_glr_with_scatter_001.svg
          :target: https://mpltern.readthedocs.io/en/latest/gallery/statistics/with_scatter.html
     - .. image:: https://mpltern.readthedocs.io/en/latest/_images/sphx_glr_10.tick_position_001.svg
          :target: https://mpltern.readthedocs.io/en/latest/gallery/axis_and_tick/10.tick_position.html

.. list-table::
   :widths: auto

   * - .. image:: https://mpltern.readthedocs.io/en/latest/_images/sphx_glr_01.triangle_rotation_001.svg
          :target: https://mpltern.readthedocs.io/en/latest/gallery/triangle/01.triangle_rotation.html
     - .. image:: https://mpltern.readthedocs.io/en/latest/_images/sphx_glr_dirichlet_pdf_001.svg
          :target: https://mpltern.readthedocs.io/en/latest/gallery/miscellaneous/dirichlet_pdf.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
===================

Please cite mpltern via the
`DOI <https://doi.org/10.5281/zenodo.3528354>`__
if mpltern contributes to a scientific publication.

`Matplotlib should also be acknowledged <https://matplotlib.org/citing.html>`__
when using mpltern.

Author
======

Yuji Ikeda `(University of Stuttgart, Germany) <https://www.imw.uni-stuttgart.de/team/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>`__