nested-grid-plotter

========================= About Nested Grid Plotter

|License| |Stars| |Python| |PyPI| |Downloads| |Build Status| |Documentation Status| |Coverage| |Codacy| |Precommit: enabled| |Code style: black| |Isort| |Ruff| |DOI|

NestedGridPlotter is based on matplotlib <https://matplotlib.org/>_ and intends to simplify the plotting of nestedgrid by providing a objected oriented class.

• Documentation: https://nested-grid-plotter.readthedocs.io.

.. |License| image:: https://img.shields.io/badge/License-MIT license-blue.svg :target: https://github.com/antoinecollet5/nested_grid_plotter/-/blob/master/LICENSE

.. |Stars| image:: https://img.shields.io/github/stars/antoinecollet5/nested_grid_plotter.svg?style=social&label=Star&maxAge=2592000 :target: https://github.com/antoinecollet5/nested_grid_plotter/stargazers :alt: Stars

.. |Python| image:: https://img.shields.io/pypi/pyversions/nested-grid-plotter.svg :target: https://pypi.org/pypi/nested-grid-plotter :alt: Python

.. |PyPI| image:: https://img.shields.io/pypi/v/nested-grid-plotter.svg :target: https://pypi.org/pypi/nested-grid-plotter :alt: PyPI

.. |Downloads| image:: https://static.pepy.tech/badge/nested-grid-plotter :target: https://pepy.tech/project/nested-grid-plotter :alt: Downoads

.. |Build Status| image:: https://github.com/antoinecollet5/nested_grid_plotter/actions/workflows/main.yml/badge.svg :target: https://github.com/antoinecollet5/nested_grid_plotter/actions/workflows/main.yml :alt: Build Status

.. |Documentation Status| image:: https://readthedocs.org/projects/nested-grid-plotter/badge/?version=latest :target: https://nested-grid-plotter.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status

.. |Coverage| image:: https://codecov.io/gh/antoinecollet5/nested_grid_plotter/branch/master/graph/badge.svg?token=ISE874MMOF :target: https://codecov.io/gh/antoinecollet5/nested_grid_plotter :alt: Coverage

.. |Codacy| image:: https://app.codacy.com/project/badge/Grade/f4991359b8e84a44bbadf4f1a70bfa21 :target: https://app.codacy.com/gh/antoinecollet5/nested_grid_plotter/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade :alt: codacy

.. |Precommit: enabled| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit :target: https://github.com/pre-commit/pre-commit

.. |Code style: black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat :target: https://github.com/psf/black :alt: Black

.. |Isort| image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat :target: https://timothycrosley.github.io/isort :alt: isort

.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json :target: https://github.com/astral-sh/ruff :alt: Ruff

.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.8215056.svg :target: https://doi.org/10.5281/zenodo.8215056

============== Changelog

1.2.0 (2024-06-12)

• IMP: add_xaxis_twin_as_date is now deprecated and replaced by the more flexible ticklabels_to_datetime and add_twin_axis_as_datetime functions. The tutorials and tests have been updated.
• IMP: make_x_axes_symmetric_zero_centered and make_x_axes_symmetric_zero_centered have now possibility to ensure minimum symmetric axis limits through the min_xlims and min_ylims keywords respectively.

1.1.2 (2024-04-27)

• FIX: bbox_extra_artists when using savefig method.

1.1.1 (2024-03-22)

• ENH: Add a get_axes interface to NestedGridPlotter class.
• ENH: Provide a add_letter_to_frames utility function.
• FIX: RunTimeError Can not put single artist in more than one figure when using
• NestedGridPlotter add_fig_legend method and using the main figure.

1.0.1 (2024-03-08)

• FIX: Prevent figures an subfigures legend cut-off by th figure box when saving images to disk.

1.0.0 (2024-01-31)

• FIX: Typo = symetry to symmetry in keywords.
• FIX: Colorbar scaling = now supports any norm and some duplication has been removed, some warnigns added.

0.1.2 (2023-12-03)

• FIX: Selection of data in animations - when the amount of data is larger than the number of frames. The fix ensures that the first frame is the first data element and that the last frame is the last data element, all other frames matching evenly spaced data element in between.
• DOCS: update animated_plotters.ipynb notebook

0.1.1 (2023-11-20)

• Add utilities align_x_axes, align_x_axes_on_values and make_x_axes_symmetric_zero_centered.
• Remove the default italic styles from titles and axis labels.
• Add a DOI (zenodo)

0.1.0 (2023-06-30)

• First release on PyPI.

MIT License

Copyright (c) 2022-2024, Antoine Collet

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.