Installation

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.10 to install splinekit (ideally Python 3.12). Python 3.11 is also compatible.

Create and activate your Python virtual environment (on Unix or MacOS)

python -m venv splinekit-env
source splinekit-env/bin/activate

On Windows,

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

To deactivate the environment use

deactivate

Minimal requirement:

pip install numpy scipy sympy matplotlib

Simply install splinekit using pip

pip install splinekit

Formatting, Type Checking, and Testing

Formatting and type checking is performed as

tox -e format
tox -e type

The testing requires a valid environment with a supported Python version and tox installed. The tests are run with the following command (automatic pick of the Python version)

tox

The tests can also be launched for a specific Python version (must match the one installed in the active environment)

tox -e py310
tox -e py311
tox -e py312

IMPORTANT: Since CI is not implemented, make sure to run, pass, and/or fix tox -e format, tox -e type, and tox.

Packaging

Using tox (preferred)

tox -e build

Using hatch

hatch build -t wheel

Development Environment

Install splinekit development environment in editable mode

pip install -e .[dev]

Building of the Documentation

To build the Sphinx documentation, install splinekit doc dependencies

pip install -e .[docs]

Run the command from the splinekit root folder

sphinx-build docs/ docs/_build/

Then, go to _build/ and open index.html to navigate the documentation locally.