inventory

module of dascore.core source

DASDAE Inventory: DASCore’s metadata model for DFOS observing systems.

The inventory extends the StationXML concept with first-class support for fiber-optic arrays. It describes the physical optical path (fiber, connectors, splices), the geometry, coupling, and label tracks along optical distance, and the interrogator configurations (acquisitions) that produced patches. Patches carry a acquisition_key (network.fiber_array.location.acquisition) which, together with time, resolves against an inventory.

Each object documents the rules it enforces.

Functions

Name Description
axis_columns Return which of a segment’s columns name which canonical axis.
inventory_to_yaml Serialize an inventory to YAML, optionally writing it to a path.

Classes

Name Description
Acquisition Time-aware, channel-like DFOS acquisition setup.
Cable Physical cable containing one or more fiber segments.
Channel Station-level time-series stream identity.
Connector Optical connector in an optical path.
CoordinateReferenceSystem Inventory-wide coordinate reference system.
CouplingCondition Acoustic coupling condition for an interval of an optical path.
CreationInfo QuakeML-style provenance for an inventory document.
DistanceMap Measured control-point map from a channel-like coordinate onto optical
Enclosure Physical housing, pipe, duct, conduit, or carrier resource.
ExternalResource External resource identified but not otherwise modeled by DASCore.
FiberArray Durable fiber-optic observing identity.
FiberSegment Length of optical fiber within a cable, patch cord, or other run.
Geometry Measured curves along an interval of an optical path.
Interrogator DFOS interrogator unit used for data collection.
Inventory Top-level DASDAE inventory manifest.
InventoryNames The names an inventory could contribute to a patch.
Network FDSN-like organizational container below an inventory.
OpticalMeasurement A characterization of the optical path or its components.
OpticalPath Continuous optical path described by independent tracks.
OpticalPathLabel Label attached to an interval of an optical path.
ResolvedContext The inventory objects an acquisition_key + time resolve to.
Response Station-specific response model associated with a channel.
Splice Optical splice in an optical path.
Station Point-like observing identity under a network.
Terminator Optical path terminator.