dascore

module of dascore

source

DASCore - A library for fiber optic sensing.

Functions

Name	Description
annotations	Load annotations from whatever holds them.
config_context	Temporarily override the runtime config for the current thread/task.
get_config	Return the active runtime configuration.
get_coord	Return a coordinate from provided inputs.
get_coord_manager	Create a coordinate manager.
get_example_inventory	Load an example Inventory.
get_example_patch	Load an example Patch.
get_example_spool	Load an example Spool.
get_format	Return the file’s format name and version.
get_quantity	Convert a value to a pint quantity.
get_unit	Convert a value to a pint unit.
inventory	Load or create a DASDAE inventory.
patch_function	Decorator to mark a function as a patch method.
read	Read a fiber file.
reset_config	Reset the process-wide runtime config base to defaults.
scan	Scan a potential patch source and return its patch summaries.
scan_payloads	Scan a potential patch source and return full coordinate payloads.
scan_to_df	Scan a path, return a dataframe of contents.
set_config	Set the process-wide runtime config, visible from every thread and task.
spool	Create a spool from a data source.
to_datetime64	Convert an object to a datetime64.
to_float	Convert various datetime/timedelta things to a float.
to_timedelta64	Convert an object to timedelta64.
write	Write a Patch or Spool to disk.

Classes

Name	Description
AnnotationSet	An immutable, dataframe-backed set of annotations over patch dimensions.
Spool	A container of patches: a view over a PatchCatalog.
CoordManager	Class for managing coordinates.
DascoreConfig	Container for runtime configuration values.
Inventory	Top-level DASDAE inventory manifest.
Patch	A Class for managing data and metadata.
PatchAttrs	The expected attributes for a Patch.
PatchProcessor	An operation on a patch, written as a class.
PatchSummary	A metadata-only summary of a patch.

Modules

Name	Description
compat	Compatibility module for DASCore.
config	Runtime configuration for DASCore.
constants	Constants used throughout DASCore.
core	Core routines and functionality for processing distributed fiber data.
examples	A module for loading examples.
exceptions	Custom dascore exceptions.
io	Modules for reading and writing fiber data.
models	DASCore’s model layer: base classes and the annotated types they are built from.
proc	Module containing patch processing routines.
transform	A module for applying transformation to Patches.
units	Module for handling units.
utils	Utilities for dascore.
version	Module for reporting the version of dascore.
warnings	Custom dascore warnings.
xarray	xarray integration: conversions between dascore and xarray objects.
viz	Module for static, matplotlib-based visualizations and figure generation.
main	Run DASCore’s CLI through the selected Python interpreter.
_cli	Typer command definitions, loaded only when the CLI is invoked.
cli	The DASCore command-line entry point.