Metadata-Version: 2.4
Name: cisl
Version: 0.3.0
Summary: Ensemble of tools for CISL data
Author-email: Yen-Ting Liu <ytliu2@illinois.edu>
License-Expression: Apache-2.0
Project-URL: Homepage, https://chemimage.illinois.edu/
Project-URL: Repository, https://github.com/chemimage/cisl-py
Project-URL: Issues, https://github.com/chemimage/cisl-py/issues
Keywords: spectroscopy,microscope,microscopy,chemical imaging
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click
Requires-Dist: coloredlogs
Requires-Dist: dask
Requires-Dist: h5py>=3.16.0
Requires-Dist: imageio
Requires-Dist: matplotlib
Requires-Dist: natsort
Requires-Dist: numpy
Requires-Dist: openpyxl>=3.1.5
Requires-Dist: pandas
Requires-Dist: parse
Requires-Dist: pint
Requires-Dist: psutil
Requires-Dist: pyfftw>=0.15.1
Requires-Dist: SciencePlots
Requires-Dist: scikit-image
Requires-Dist: scipy
Requires-Dist: spectral
Requires-Dist: tifffile
Requires-Dist: xarray
Provides-Extra: baseline
Requires-Dist: pybaselines; extra == "baseline"
Dynamic: license-file

# cisl

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

## Installation

The package is available from PyPI:

```powershell
uv add cisl
```

For the latest development version, install from GitHub:

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

### Quick Demo

Example notebooks are available in
[cisl-py-playground](https://github.com/chemimage/cisl-py-playground/tree/main/notebooks),
including demos for reading common CISL data formats, spectral processing,
stitching, plotting, and simulation workflows.

## Development Setup

This project is managed with [`uv`](https://docs.astral.sh/uv/). To install the
project and development dependencies:

```powershell
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](https://github.com/chemimage/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:

```powershell
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.
