Skip to content

Commit 5260c86

Browse files
committed
docs: update readme and docs
1 parent e9522a3 commit 5260c86

File tree

3 files changed

+22
-8
lines changed

3 files changed

+22
-8
lines changed

README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ or Poetry:
2828
poetry add csaps
2929
```
3030

31-
The module depends only on NumPy and SciPy. Python 3.9 or above is supported.
31+
The module depends only on NumPy and SciPy. Python 3.10 or above is supported.
3232

3333
## Simple Examples
3434

@@ -97,28 +97,42 @@ plt.show()
9797

9898
More examples of usage and the full documentation can be found at https://csaps.readthedocs.io.
9999

100-
## Testing
100+
# Development
101101

102-
We use pytest for testing.
102+
We use Poetry to manage the project:
103103

104104
```
105105
git clone https://github.com/espdev/csaps.git
106106
cd csaps
107-
poetry install
107+
poetry install -E docs
108+
```
109+
110+
Also, install pre-commit hooks:
111+
112+
```
113+
poetry run pre-commit install
114+
```
115+
116+
## Testing and Linting
117+
118+
We use pytest for testing and ruff/mypy for linting.
119+
Use `poethepoet` to run tests and linters:
120+
121+
```
108122
poetry run poe test
123+
poetry run poe check
109124
```
110125

111126
## Algorithm and Implementation
112127

113128
**csaps** Python package is inspired by MATLAB [CSAPS](https://www.mathworks.com/help/curvefit/csaps.html) function that is an implementation of
114129
Fortran routine SMOOTH from [PGS](http://pages.cs.wisc.edu/~deboor/pgs/) (originally written by Carl de Boor).
115130

116-
Also the algothithm implementation in other languages:
131+
Also, the algothithm implementation in other languages:
117132

118133
* [csaps-rs](https://github.com/espdev/csaps-rs) Rust ndarray/sprs based implementation
119134
* [csaps-cpp](https://github.com/espdev/csaps-cpp) C++11 Eigen based implementation (incomplete)
120135

121-
122136
## References
123137

124138
C. de Boor, A Practical Guide to Splines, Springer-Verlag, 1978.

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
# -- Project information -----------------------------------------------------
2020

2121
project = 'csaps'
22-
copyright = '2017-2023, Eugene Prilepin' # noqa
22+
copyright = '2017-2025, Eugene Prilepin' # noqa
2323
author = 'Eugene Prilepin'
2424

2525

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ You can install and update csaps using pip:
4040
4141
The module depends only on NumPy and SciPy.
4242

43-
Python 3.6 or above is supported.
43+
Python 3.10 or above is supported.
4444

4545
Content
4646
-------

0 commit comments

Comments
 (0)