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.

Schema Reference#

Workplans#

Schemas for the built-in Workplan are listed here.

Blueprints#

Schemas for the built-in blueprints are listed here.

ROMS-MARBL Blueprint#

The roms_marbl blueprint enables the orchestration of an application that executes a ROMS simulation.

Hello World Blueprint#

The hello_world blueprint is an example starting point for creating and running custom applications with user-provided blueprints.

Plotter Blueprint#

The plotter blueprint is a more complex example of creating and running a custom application with user-provided blueprints.