cstar.roms.ROMSSimulation.from_blueprint

Contents

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.from_blueprint#

classmethod ROMSSimulation.from_blueprint(blueprint: str)#

Create a ROMSSimulation instance from a YAML blueprint.

This method reads a YAML blueprint file, extracts the relevant configuration details, and initializes a ROMSSimulation object using the extracted data.

Parameters:: blueprint (str) – The path or URL to the YAML blueprint file.
Returns:: ROMSSimulation – An initialized ROMSSimulation instance based on the blueprint data.
Raises:: ValueError – If the blueprint file is not in YAML format or if required fields are missing.

See also

to_blueprint: Saves the simulation as a YAML blueprint.
from_dict: Creates an instance from a dictionary representation.