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.ROMSSimulation.setup#
- ROMSSimulation.setup() None#
Prepare this ROMSSimulation locally by fetching necessary files and compiling any external codebases.
This method ensures that all required components (codebases, runtime code, compile-time code, and input datasets) are correctly retrieved and configured in the simulation directory.
The method performs the following steps: 1. Configures the ROMS and MARBL external codebases. 2. Fetches and organizes compile-time code. 3. Fetches and organizes runtime code (e.g., namelists). 4. Fetches and prepares input datasets.
- Raises:
ValueError – If any required component (e.g., runtime code, compile-time code) is missing.
RuntimeError – If there is an issue configuring the external codebases.
Notes
Input datasets are only fetched if their date range overlaps the simulation’s start and end dates.