Installation

PyCCAPT requires Python >=3.9.

Recommended Conda Workflow

For most users, the smoothest setup is a conda environment with a pip install:

conda create -n pyccapt python=3.11
conda activate pyccapt
python -m pip install --upgrade pip
pip install "pyccapt[full]"

For a local checkout of this repository:

git clone https://github.com/mmonajem/pyccapt.git
cd pyccapt
conda activate pyccapt
pip install -e ".[full]"

Default installation (core dependencies only):

pip install pyccapt

Install optional dependency groups:

pip install "pyccapt[calibration]"
pip install "pyccapt[control]"
pip install "pyccapt[full]"

[full] installs both control and calibration dependency sets.

From the project root:

pip install -e ".[full]"

Module-specific editable installs:

pip install -e ".[control]"
pip install -e ".[calibration]"

If PyCCAPT is available on your selected conda channel:

conda install -c conda-forge pyccapt

Build and install locally from this repository:

conda install -c conda-forge conda-build
conda build conda-recipe
conda install --use-local pyccapt

If you need both optional dependency sets in that environment:

pip install "pyccapt[full]"

You can also create predefined environments:

conda env create -f environment.yml
conda env create -f environment.full.yml

After installation:

pyccapt

Alternative entrypoint:

python -m pyccapt.control

Start JupyterLab:

jupyter lab

Then open notebooks under pyccapt/calibration/tutorials.

Run module-specific test suites:

pytest -q --run-calibration
pytest -q --run-control

Run all discoverable tests with currently installed optional dependencies:

pytest -q