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.

cstar.roms.external_codebase.ROMSExternalCodeBase.get

ROMSExternalCodeBase.get(target_dir: Path | None = None) → None

Retrieve and stage this ExternalCodeBase

Parameters:

target_dir (Path or None) – The directory to clone the codebase to on the local filesystem. Defaults to an internal directory in the C-Star package root.