diff --git a/CHANGELOG.md b/CHANGELOG.md index 561a31f..a5b2236 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ # Changelog +## v1.3.1 (14.04.2025) + +* Update readme and docs + ## v1.3.0 (14.04.2025) * Bump minimal Python version to 3.10 diff --git a/README.md b/README.md index ec9b03a..b864f30 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ or Poetry: poetry add csaps ``` -The module depends only on NumPy and SciPy. Python 3.9 or above is supported. +The module depends only on NumPy and SciPy. Python 3.10 or above is supported. ## Simple Examples @@ -97,15 +97,30 @@ plt.show() More examples of usage and the full documentation can be found at https://csaps.readthedocs.io. -## Testing +# Development -We use pytest for testing. +We use Poetry to manage the project: ``` git clone https://github.com/espdev/csaps.git cd csaps -poetry install +poetry install -E docs +``` + +Also, install pre-commit hooks: + +``` +poetry run pre-commit install +``` + +## Testing and Linting + +We use pytest for testing and ruff/mypy for linting. +Use `poethepoet` to run tests and linters: + +``` poetry run poe test +poetry run poe check ``` ## Algorithm and Implementation @@ -113,12 +128,11 @@ poetry run poe test **csaps** Python package is inspired by MATLAB [CSAPS](https://www.mathworks.com/help/curvefit/csaps.html) function that is an implementation of Fortran routine SMOOTH from [PGS](http://pages.cs.wisc.edu/~deboor/pgs/) (originally written by Carl de Boor). -Also the algothithm implementation in other languages: +Also, the algothithm implementation in other languages: * [csaps-rs](https://github.com/espdev/csaps-rs) Rust ndarray/sprs based implementation * [csaps-cpp](https://github.com/espdev/csaps-cpp) C++11 Eigen based implementation (incomplete) - ## References C. de Boor, A Practical Guide to Splines, Springer-Verlag, 1978. diff --git a/docs/conf.py b/docs/conf.py index 3c943fb..182f6a9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,7 +19,7 @@ # -- Project information ----------------------------------------------------- project = 'csaps' -copyright = '2017-2023, Eugene Prilepin' # noqa +copyright = '2017-2025, Eugene Prilepin' # noqa author = 'Eugene Prilepin' diff --git a/docs/index.rst b/docs/index.rst index 5a3578c..4d16072 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -40,7 +40,7 @@ You can install and update csaps using pip: The module depends only on NumPy and SciPy. -Python 3.6 or above is supported. +Python 3.10 or above is supported. Content ------- diff --git a/pyproject.toml b/pyproject.toml index df58123..670062e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "csaps" -version = "1.3.0" +version = "1.3.1" description = "Cubic spline approximation (smoothing)" authors = ["Evgeny Prilepin "] license = "MIT"