Inventory

class of dascore.core.inventory
inherits from: InventoryModel, DascoreBaseModel, pydantic.main.BaseModel
source

Inventory(
    description: str = ““,
    extra_fields: collections.abc.Mapping[str, str | int | float | bool[str, int, float, bool]] = ,
    schema_version: int = 1,
    resource_id: str = ,
    creation_info: CreationInfo = ,
    resources: collections.abc.Mapping[str, dascore.core.inventory.Interrogator | dascore.core.inventory.Cable | dascore.core.inventory.Enclosure | dascore.core.inventory.ExternalResource | dascore.core.inventory.OpticalMeasurement[Interrogator, Cable, Enclosure, ExternalResource, OpticalMeasurement]] = ,
    coordinate_reference_system: CoordinateReferenceSystem = ,
    networks: tuple[Network, …] = (),
)-> None

Top-level DASDAE inventory manifest.

Stores document metadata, shareable resources keyed by resource_id, the inventory-wide coordinate reference system, and network containers.

Methods

Name Description
check Check the whole inventory tree against the model rules.
from_yaml Load an inventory from YAML text.
get_names Return the names this inventory could contribute to a patch.
get_resource Return the shareable resource registered under a resource_id.
new Create a new instance with some attributes updated.
replace Return a new inventory with one component replaced.
resolve Resolve an acquisition_key (and time) to its inventory context.
to_yaml Serialize this inventory to YAML, optionally writing to a path.