Metadata-Version: 2.1
Name: PyFinitDiff
Version: 1.1.2
Summary: A package finit-difference matrix generation.
Home-page: https://github.com/MartinPdeS/PyFinitDiff
Author: Martin Poinsinet de Sivry
Author-email: Martin.poinsinet.de.sivry@gmail.com
License: MIT
Platform: unix
Platform: linux
Platform: osx
Platform: windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
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
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: matplotlib
Requires-Dist: MPSPlots
Requires-Dist: tabulate
Provides-Extra: development
Requires-Dist: numpydoc ==1.6.0 ; extra == 'development'
Requires-Dist: sphinx >=5.1.1 ; extra == 'development'
Requires-Dist: sphinx-gallery >=0.11.1 ; extra == 'development'
Requires-Dist: sphinx-rtd-theme >=1.0.0 ; extra == 'development'
Requires-Dist: docutils ==0.20.1 ; extra == 'development'
Requires-Dist: pydata-sphinx-theme ; extra == 'development'
Requires-Dist: pytest >=0.6 ; extra == 'development'
Requires-Dist: pytest-cov >=2.0 ; extra == 'development'
Requires-Dist: pytest-json-report ; extra == 'development'
Requires-Dist: coverage ; extra == 'development'
Requires-Dist: numpy ; extra == 'development'
Requires-Dist: scipy ; extra == 'development'
Requires-Dist: matplotlib ; extra == 'development'
Requires-Dist: MPSPlots ; extra == 'development'
Requires-Dist: tabulate ; extra == 'development'
Provides-Extra: documentation
Requires-Dist: numpydoc ==1.6.0 ; extra == 'documentation'
Requires-Dist: sphinx >=5.1.1 ; extra == 'documentation'
Requires-Dist: sphinx-gallery >=0.11.1 ; extra == 'documentation'
Requires-Dist: sphinx-rtd-theme >=1.0.0 ; extra == 'documentation'
Requires-Dist: docutils ==0.20.1 ; extra == 'documentation'
Requires-Dist: pydata-sphinx-theme ; 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 ; extra == 'testing'
Requires-Dist: coverage ; 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




