Installation Guide#
Step-by-step Guides#
Choose the guide for your computer. Each one gives complete, step-by-step instructions, from installing the tools to checking that SpectroChemPy works:
Install in Google Colaboratory (Colab): run SpectroChemPy in your browser, with nothing to install on your computer
Other cases:
Installation from Sources: development version, contributors
Plugins and Example Data: plugins, example data and other optional packages
Note
Installation security notice
Due to a recent security issue affecting Python package managers, please make sure your installation tools are up to date before installing SpectroChemPy.
See the official Python Packaging Authority guidance for instructions.
Quick Install (experienced users)#
For users already familiar with Python environments: SpectroChemPy requires
Python 3.11 or newer and is available on PyPI and on the spectrocat conda
channel. In an activated environment:
uv pip install spectrochempy # or: python -m pip install spectrochempy
mamba install -c conda-forge -c spectrocat spectrochempy
To run the tutorial notebooks, also install JupyterLab (uv pip install jupyterlab,
python -m pip install jupyterlab or mamba install -c conda-forge jupyterlab).
To pin an exact version, use "spectrochempy==1.0.0" (pip, uv) or
"spectrochempy=1.0.0" (conda, mamba). To install a pre-release, when one is
available: uv pip install spectrochempy --prerelease allow (or
python -m pip install --pre spectrochempy).
To install the development version (the current master branch, documented
as latest on this site), git must be installed:
uv pip install "spectrochempy @ git+https://github.com/spectrochempy/spectrochempy.git"
# or: python -m pip install "spectrochempy @ git+https://github.com/spectrochempy/spectrochempy.git"
Development versions are not published on the conda channels. To modify the code or contribute, see Installation from Sources.