cstar.roms.ROMSSimulation.to_dict

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

ROMSSimulation.to_dict() → dict#

Convert the ROMSSimulation instance into a dictionary representation.

This method serializes the attributes of the ROMSSimulation instance into a dictionary, allowing it to be stored, transferred, or reconstructed later.

Returns:

dict – A dictionary representation of the ROMSSimulation, including its name, codebases, discretization, runtime and compile-time code, input datasets, and metadata.

Notes

  • This method ensures that all relevant attributes are properly formatted for serialization.

  • Input datasets and additional code attributes are stored as nested dictionaries.

  • The dictionary produced by this method can be used with from_dict to reconstruct the ROMSSimulation instance.

See also

from_dict

Reconstructs a ROMSSimulation instance from a dictionary.

to_blueprint

Saves the dictionary representation as a YAML blueprint.