Splinx

A jax implementation of B-splines.

Installation

Using Mamba:

• Create a new Mamba environment

mamba create -n splinx python=3.12

• Activate the Mamba environment

mamba activate splinx

• Navigate into the top level folder and pip install the package.

pip install -e .

• Open a Python REPL and try running an example to test the installation

import splinx

Developer Dependencies

To install optional packages to help with development, run pip with the .[dev] option:

pip install -e ".[dev]"

This will install (among other things) Pytest and Material for MkDocs.

To test the b-spline functionality, run:

python -m pytest tests/test_bspline.py 

Writing Documentation

This repo has Material for MkDocs set up. You can read more at the official documentation.

To launch the documentation locally in a web browser:

• Install the developer dependencies as per above
• Activate the Mamba environment and navigate to the top level folder
• Run the following:

mkdocs serve

• Open the link that appears in the terminal.

Changes to the files in docs are reflected live as you save individual documents.