core.config
Core configuration and vocabulary definitions for xmris xarray objects.
This module defines the single source of truth for all metadata attributes, dimensions, coordinates, and data variables expected by the xmris package.
Classes¶
| Name | Description |
|---|---|
| BaseVocabulary | Base class for xmris xarray vocabularies. |
| XmrisAttributes | Official metadata attribute keys for xmris xarray objects (.attrs). |
| XmrisCoordinates | Official coordinate names for xmris xarray objects (.coords). |
| XmrisDataVars | Official data variable names for xmris xarray Datasets (.data_vars). |
| XmrisDimensions | Official dimension names for xmris xarray objects (.dims). |
| XmrisTerm | A string subclass that holds metadata attributes. |
BaseVocabulary¶
core.config.BaseVocabulary()Base class for xmris xarray vocabularies.
Provides rich HTML display for Jupyter Notebooks and utility methods to fetch metadata for validation decorators.
Methods¶
| Name | Description |
|---|---|
| get_description | Fetch the description for a given xarray key value. |
get_description¶
core.config.BaseVocabulary.get_description(target_value)Fetch the description for a given xarray key value.
Used by the validation decorators to build dynamic docstrings.
Parameters¶
| Name | Type | Description | Default |
|---|---|---|---|
| target_value | str | The actual string value of the attribute/dimension/coordinate (e.g., “MHz”, “time”). | required |
Returns¶
| Name | Type | Description |
|---|---|---|
| str | The description string, or a fallback message if not found. |
XmrisAttributes¶
core.config.XmrisAttributes()Official metadata attribute keys for xmris xarray objects (.attrs).
XmrisCoordinates¶
core.config.XmrisCoordinates()Official coordinate names for xmris xarray objects (.coords).
XmrisDataVars¶
core.config.XmrisDataVars()Official data variable names for xmris xarray Datasets (.data_vars).
XmrisDimensions¶
core.config.XmrisDimensions()Official dimension names for xmris xarray objects (.dims).
XmrisTerm¶
core.config.XmrisTerm()A string subclass that holds metadata attributes.
This allows xarray to treat it as a standard dimension/coordinate name,
while allowing developers to access .unit and .description directly.
Attributes¶
| Name | Description |
|---|---|
long_name | Automatically generates a display-friendly long name. |