cisl 0.3.0

Ensemble of tools for CISL data

cisl

cisl is a collection of support tools for CISL data processing and analysis.

Installation

The package is available from PyPI:

uv add cisl

For the latest development version, install from GitHub:

uv add git+https://github.com/chemimage/cisl-py.git

Quick Demo

Example notebooks are available in cisl-py-playground, including demos for reading common CISL data formats, spectral processing, stitching, plotting, and simulation workflows.

Development Setup

This project is managed with uv. To install the project and development dependencies:

uv sync --dev

uv creates a local virtual environment in .venv and uses the Python version declared in .python-version (3.12).

For notebook-based experiments, use the cisl-py-playground repository. It keeps exploratory notebooks separate from the package source while using this repository as a nested dependency.

Test Data

Some tests depend on sample datasets under tests/samples/, and those files are tracked with Git LFS rather than regular git blobs.

After cloning the repository, fetch them with:

git lfs install
git lfs pull

If files under tests/samples/ look like small pointer text files instead of real binary data, Git LFS content has not been downloaded yet.