Metadata-Version: 2.1
Name: PyFinitDiff
Version: 2.0.0.post0
Summary: A package finit-difference matrix generation.
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.
        
Project-URL: Homepage, https://github.com/MartinPdeS/PyFinitDiff
Project-URL: Documentation, https://pyfinitdiff.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/MartinPdeS/PyFinitDiff.git
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: Topic :: Scientific/Engineering :: Physics
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Science/Research
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: pydantic>=2.6.3
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: MPSPlots
Requires-Dist: tabulate
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"
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"

PyFinitDiff
===========

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

A Python package to compute finit-difference matrices with an intuitive API.


----

Documentation
**************
All the latest available documentation is available `here <https://pyfinitdiff.readthedocs.io/en/latest/>`_ or you can click the following badge:

|docs|


----

Installation
------------


Pip installation
****************

The package have been uploaded as wheel for a few OS (Linux, MacOS) and need Python 3.10+ version.
As such, with the adequate configuration one can simply do

.. code-block:: python

   >>> pip3 install PyFinitDiff


----

Testing
*******

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

.. code:: python

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

----


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

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

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

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


.. |python| image:: https://img.shields.io/badge/Made%20with-Python-1f425f.svg
   :target: https://www.python.org/

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

.. |unittest| image:: https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/MartinPdeS/19aef38017fa4be1dc71b6f5d853a932/raw

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

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




