Skip to content

MartinPdeS/PyFinitDiff

Repository files navigation

PyFinitDiff

python Documentation Status 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 or you can click the following badge:

Documentation Status


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

>>> 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

>>> 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 .

Email:martin.poinsinet-de-sivry@polymtl.ca .

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages