Metadata-Version: 2.1
Name: MPSPlots
Version: 1.4.12.post0
Summary: A matplotlib wrapper for defered plots.
Author-email: Martin Poinsinet de Sivry-Houle <martin.poinsinet.de.sivry@gmail.com>
License: MIT License
        
        Copyright (c) 2020 Martin de Sivry
        
        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.
        
Keywords: finit-difference,matrix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: matplotlib
Requires-Dist: pydantic>=2.6.3
Requires-Dist: numpy==1.*
Requires-Dist: pathvalidate==3.2.0
Requires-Dist: pyvista==0.43.1
Requires-Dist: vtk
Requires-Dist: shapely>=2.0.0
Provides-Extra: testing
Requires-Dist: pytest>=0.6; extra == "testing"
Requires-Dist: pytest-cov>=2.0; extra == "testing"
Requires-Dist: pytest-json-report==1.5.0; extra == "testing"
Requires-Dist: mypy>=0.910; extra == "testing"
Requires-Dist: flake8>=3.9; extra == "testing"
Requires-Dist: tox>=3.24; extra == "testing"
Requires-Dist: coverage==6.5.0; extra == "testing"
Provides-Extra: documentation
Requires-Dist: numpydoc==1.6.0; extra == "documentation"
Requires-Dist: sphinx>=5.1.1; extra == "documentation"
Requires-Dist: sphinx-gallery==0.15.0; extra == "documentation"
Requires-Dist: sphinx-rtd-theme==2.0.0; extra == "documentation"
Requires-Dist: pydata-sphinx-theme==0.14.1; extra == "documentation"

MPSPlots
========


|python|
|docs|
|unittest|
|PyPi|
|PyPi_download|


The library
***********

My personal Matplotlib[2D]/PyVista[3D] wrapper. Its aim is to offer a good compromise between ease-of-use and flexibility. I have started this library in order to uniformise my plots for scientific journal and as of today I continue to update and distribute the code.

----

Testing
*******

To test localy (with cloning the GitHub repository) you'll need to install the dependencies and run the coverage command as

.. code:: console

   >>> git clone https://github.com/MartinPdeS/MPSPlots.git
   >>> cd MPSPlots
   >>> pip install -r requirements/requirements.txt
   >>> coverage run --source=MPSPlots --module pytest --verbose tests
   >>> coverage report --show-missing

----

Contact Information
*******************

As of 2023 the project is still under development if you want to collaborate it would be a pleasure! I encourage you to contact me.

MPSPlots was written by `Martin Poinsinet de Sivry-Houle <https://github.com/MartinPdeS>`_  .

Email:`martin.poinsinet-de-sivry@polymtl.ca <mailto:martin.poinsinet-de-sivry@polymtl.ca?subject=MPSPlots>`_ .


.. |python| image:: https://img.shields.io/pypi/pyversions/mpsplots.svg
   :target: https://www.python.org/

.. |PyPi| image:: https://badge.fury.io/py/MPSPlots.svg
   :alt: PyPi package
   :target: https://pypi.org/project/MPSPlots/

.. |docs| image:: https://readthedocs.org/projects/mpsplots/badge/?
   :target: https://mpsplots.readthedocs.io/en/latest/
   :alt: Documentation Status

.. |unittest| image:: https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/MartinPdeS/f0955be398d59efac69042c1b0fbece2/raw/b0469e6a361cc54c19eca1f23662b3ad0b76b1ce/MPSPlotscoverage_badge.json
   :alt: Unittest coverage
   :target: https://github.com/MartinPdeS/MPSPlots/actions

.. |PyPi_download| image:: https://img.shields.io/pypi/dm/MPSPlots.svg
   :target: https://pypistats.org/packages/mpsplots
