Metadata-Version: 2.4
Name: splinekit
Version: 0.1.0
Summary: A set of functions and classes to handle periodic 1D polynomial splines
Project-URL: Homepage, https://github.com/splinekit/splinekit
Project-URL: Documentation, https://splinekit.github.io/
Project-URL: Repository, https://github.com/splinekit/splinekit.git
Project-URL: Issues, https://github.com/splinekit/splinekit/issues
Project-URL: Source, https://github.com/splinekit/splinekit
Project-URL: PyPI, https://pypi.org/project/splinekit/
Author-email: Philippe Thévenaz <philippe.thevenaz@icloud.com>
Maintainer-email: Philippe Thévenaz <philippe.thevenaz@icloud.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.11
Requires-Dist: matplotlib>=3.8
Requires-Dist: numpy>=1.26
Requires-Dist: scipy>=1.15
Requires-Dist: sympy>=1.12
Provides-Extra: dev
Requires-Dist: build; extra == 'dev'
Requires-Dist: ipykernel>=7.1.0; extra == 'dev'
Requires-Dist: ipython>=8.26; extra == 'dev'
Requires-Dist: ipywidgets>=8; extra == 'dev'
Requires-Dist: mypy>=1.8; extra == 'dev'
Requires-Dist: pytest>=6.0; extra == 'dev'
Requires-Dist: tox>=4.13; extra == 'dev'
Provides-Extra: docs
Requires-Dist: ipython>=8.26; extra == 'docs'
Requires-Dist: myst-parser>=3.0; extra == 'docs'
Requires-Dist: nbsphinx>=0.9; extra == 'docs'
Requires-Dist: sphinx-copybutton>=0.5; extra == 'docs'
Requires-Dist: sphinx-design>=0.6; extra == 'docs'
Requires-Dist: sphinx-gallery>=0.17; extra == 'docs'
Requires-Dist: sphinx-prompt>=1.8; extra == 'docs'
Requires-Dist: sphinx-remove-toctrees>=1.0; extra == 'docs'
Requires-Dist: sphinx-rtd-theme>=3.0.2; extra == 'docs'
Requires-Dist: sphinx>=7.3; extra == 'docs'
Provides-Extra: tests
Requires-Dist: pytest>=6.0; extra == 'tests'
Requires-Dist: tox>=4.13; extra == 'tests'
Provides-Extra: visualization
Requires-Dist: ipython>=8.26; extra == 'visualization'
Description-Content-Type: text/markdown

<!-- splinekit/README.md -->

# splinekit: Spline Operations
`splinekit` is a Python-based open-source software library aimed at the
manipulation of one-dimensional periodic splines.

## Installation
You need at least `Python 3.11` to install `splinekit`.

Creation and activation of your Python virtual environment

(on Unix)
```shell
python -m venv splinekit-env
source splinekit-env/bin/activate
```

(on macOS)
```shell
python3 -m venv splinekit-env
source splinekit-env/bin/activate
```

(on Windows)

```shell
python -m venv splinekit-env
.splinekit-env/Scripts/Activate
```

To deactivate the environment use

```shell
deactivate
```

Minimal requirement

```shell
pip install numpy scipy sympy matplotlib
```

The interactive part of the documentation is deployed on Jupyter Lab

```shell
pip install jupyterlab ipywidgets
```

Install the `splinekit` library itself

```shell
pip install splinekit
```

## Development Environment
Install `splinekit` development environment in editable mode

```shell
pip install -e .[dev]
```
