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.tree

ROMSSimulation.tree()

Display a tree-style representation of the ROMS simulation structure.

This method prints a hierarchical representation of the ROMSSimulation instance, showing the organization of runtime code, compile-time code, and input datasets. It mimics the directory structure that will exist after calling setup(), but does not require setup() to have been run.

Examples

>>> simulation.tree()
/path/to/simulation
└─── ROMS
     ├── runtime_code
     │   ├── namelist_file.in
     │   └──  marbl_in
     ├── compile_time_code
     │   └── some_source_file.F90
     └──  input_datasets
          ├── grid_file.nc
          └──  forcing_file.nc

Notes

• The displayed tree is based on the files tracked by the ROMSSimulation instance.

• It does not necessarily reflect the actual state of the filesystem.