Installation

Attention

This project is still in an early phase of development.

The python API is not yet stable, and some aspects of the schema for the blueprint and workplan will likely evolve. Therefore whilst you are welcome to try out using the package, we cannot yet guarantee backwards compatibility. We expect to reach a more stable version in 2026.

Installation#

Clone the repository#

To obtain the latest development version, clone this repository:

Cloning the repository#
git clone https://github.com/CWorthy-ocean/C-Star.git
cd C-Star

Create a python virtual environment#

Select one of the following environment configuration files provided in the repository to create your environment.

  • Use ci/environment_hpc.yml on a supported HPC system (environment management by Linux Environment Modules)

  • Use ci/environment.yml on a generic machine like a laptop (environment managed by conda)

Creating a virtual environment on HPC#
conda env create -f ci/environment_hpc.yml
Creating a virtual environment on non-HPC#
conda env create -f ci/environment.yml

Once the environment is created, ensure it is activated:

Activating the virtual environment#
conda activate cstar_env

Install C-Star#

Finally, install C-Star in your active conda environment:

This method installs the package in editable mode.

It is recommended for developers modifying the source code.

pip install -e .

This method installs the package in non-editable mode.

It is recommended for those building on top of C-Star.

pip install .

This method installs optional dependencies for development and documentation generation.

It is required for those contributing code to C-Star.

pip install -e .[dev,docs]

Verify the installation#

Execute the following command to verify that C-Star is installed correctly:

Verifying package installation#
cstar --version