model.variables.base

Core metadata types and controlled vocabularies for model variables.

This module defines variable categories, source labels, and the Variable dataclass used by the registry and documentation tooling.

Module Contents

Classes

Variable

Metadata definition for a model variable used in ADELM.

Data

CATEGORIES
CATEGORY_NOTES
SOURCES
SOURCE_NOTES

API

model.variables.base.CATEGORIES

None

model.variables.base.CATEGORY_NOTES

None

model.variables.base.SOURCES

None

model.variables.base.SOURCE_NOTES

None

class model.variables.base.Variable

Metadata definition for a model variable used in ADELM.

Each model variable is defined once with typed metadata so the registry can initialize containers and generate Sphinx tables consistently.

name: str

None

units: str

None

description: str

None

category: str

None

source: str | None

None

default: float | None

None

produced_by: tuple[str, ...]

()

used_by: tuple[str, ...]

()