Installation

ftmwpipeline is a Python package (Python 3.9 or later).

From PyPI

The standard installation is from PyPI:

pip install ftmwpipeline

This pulls in the runtime dependencies — the scientific Python stack (NumPy, SciPy, Matplotlib, pandas, h5py, PyYAML, tqdm) and the blackchirp module that the Blackchirp data loader uses for format-tolerant reading of spectrometer data.

Optional dependency groups are available as extras:

• [dev] — testing, linting, and type-checking tools.

• [docs] — the Sphinx toolchain for building this documentation.

• [notebook] — Jupyter, IPython, and widget support for interactive use.

pip install "ftmwpipeline[dev]"

From source

To work from a clone — for development, or to track the latest changes — conda manages the scientific-computing dependencies. Two environment files are provided, and both install the package itself in editable mode.

The minimal runtime environment:

conda env create -f environment.yml
conda activate ftmwpipeline

The development environment, a superset that adds the test suite, linters, type checker, and documentation tooling:

conda env create -f environment-dev.yml
conda activate ftmwpipeline-dev

If you manage your own environment, install the package in editable mode directly:

pip install -e ".[dev,docs]"

Verifying the installation

Confirm that the command-line entry point and its dependencies are in place:

ftmwpipeline validate
ftmwpipeline version

validate reports the status of the installation and its dependencies; version prints the package version and confirms the matplotlib visualization backend is available.