rompy.core.BaseConfig

pydantic model rompy.core.BaseConfig

Base class for model templates.

The template class provides the object that is used to set up the model configuration. When implemented for a given model, can move along a scale of complexity to suit the application.

In its most basic form, as implemented in this base object, it consists of path to a cookiecutter template with the class providing the context for the {{config}} values in that template. Note that any {{runtime}} values are filled from the ModelRun object.

If the template is a git repo, the checkout parameter can be used to specify a branch or tag and it will be cloned and used.

If the object is callable, it will be colled prior to rendering the template. This mechanism can be used to perform tasks such as fetching exteral data, or providing additional context to the template beyond the arguments provided by the user..

Fields:

• checkout (str | None)

• model_type (Literal['base'])

• template (str | None)

field checkout: str | None = 'main'

The git branch to use if the template is a git repo

field model_type: Literal['base'] = 'base'

field template: str | None = '/opt/hostedtoolcache/Python/3.10.14/x64/lib/python3.10/site-packages/rompy/templates/base'

The path to the model template