Metadata-Version: 2.1
Name: mpl-axes-aligner
Version: 1.3
Summary: Adjust the plotting range of matplotlib.axes.Axes objects to align the origins with the given position
Home-page: https://github.com/ryutok/mpl_axes_aligner
Author: ryutok
Author-email: ryutokm+os@gmail.com
License: MIT
Description: =======================
        Matplotlib Axes Aligner
        =======================
        
        .. image:: https://github.com/ryutok/mpl_axes_aligner/actions/workflows/python-app.yml/badge.svg?branch=master
           :target: https://github.com/ryutok/mpl_axes_aligner/actions/workflows/python-app.yml
           :alt: Build Status
        .. image:: https://badge.fury.io/py/mpl-axes-aligner.svg
           :target: https://badge.fury.io/py/mpl-axes-aligner
           :alt: PyPI Package
        .. image:: https://readthedocs.org/projects/matplotlib-axes-aligner/badge/?version=latest
           :target: https://matplotlib-axes-aligner.readthedocs.io/en/latest/?badge=latest
           :alt: Documentation Status
        .. image:: http://img.shields.io/badge/license-MIT-blue.svg?style=flat
           :target: https://github.com/ryutok/mpl_axes_aligner/blob/master/LICENSE
           :alt: MIT License
        
        
        Overview
        ========
        
        *Matplotlib axes aligner* (``mpl_axes_aligner``) package contains the modules which adjust the plotting range of `matplotlib.axes.Axes <https://matplotlib.org/api/axes_api.html#matplotlib.axes.Axes>`_ objects to align their origins.
        
        - ``mpl_axes_aligner.shift`` expands or shifts the plotting range of a matplotlib axis to align the origin with the given position.
        - ``mpl_axes_aligner.align`` adjust the plotting range of two matplotlib axes to align their origins with the given position.
        
        
        Usage
        =====
        
        ::
        
           import numpy as np
           import matplotlib.pyplot as plt
           import mpl_axes_aligner
        
           x = np.arange(0.0, 30, 0.1)
           y1 = 0.1 * x * np.sin(x)
           y2 = 0.001*x**3 - 0.03*x**2 + 0.12*x
        
           fig = plt.figure()
           ax1 = fig.add_subplot(111)
           ax2 = ax1.twinx()
        
           ax1.plot(x, y1, color='blue', label='Plot 1')
           ax2.plot(x, y2, color='red', label='Plot 2')
        
           # Align y = 0 of ax1 and ax2 with the center of figure.
           mpl_axes_aligner.align.yaxes(ax1, 0, ax2, 0, 0.5)
        
           plt.show()
        
        .. image:: https://github.com/ryutok/mpl_axes_aligner/blob/master/docs/img/intro_plt.png?raw=true
        
        
        Documentation
        =============
        
        https://matplotlib-axes-aligner.rtfd.io
        
        
        Installation
        ============
        Install from `PyPI <https://pypi.org/project/mpl-axes-aligner/>`_::
        
          pip install mpl-axes-aligner
        
        
        Requirements
        ============
        
        - Python == 2.7, 3.4, 3.5, 3.6
        - Matplotlib == 2.2, 3.0
        
        Python 3.7 may be available, but it is not checked.
        
        
        Testing
        =======
        
        In the top directory of mpl_axes_aligner, install required packages for the tests::
        
          pip install -e .
          pip install -e .\[test\]
        
        Run the test programs::
        
          make test
        
        
        Build documents
        ===============
        
        In the top directory of mpl_axes_aligner, install required packages for the document building::
        
          pip install -e .
          pip install -e .\[doc\]
        
        Build the documents::
        
          make doc
        
        
        License
        =======
        
        `MIT License <https://github.com/ryutok/mpl_axes_aligner/blob/master/LICENSE>`_
        
        
        Author
        ======
        
        `ryutok <https://github.com/ryutok>`_
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Visualization
Provides-Extra: test
Provides-Extra: doc
Provides-Extra: release
