Skip to content

Latest commit

 

History

History
105 lines (78 loc) · 3.91 KB

README.md

File metadata and controls

105 lines (78 loc) · 3.91 KB
Raw

time-series-metadata

CircleCI Documentation Status DOI

A metrologically enabled time-series metadata scheme

time-series-metadata is a Python implementation of a metadata scheme for time-series with measurement uncertainties. It is developed jointly by software developers and researchers from Physikalisch-Technische Bundesanstalt (Germany) and Institute for Manufacturing (UK) as part of the joint European Research Project EMPIR 17IND12 Met4FoF and the German research project FAMOUS.

time-series-metadata is written in Python 3 and strives to run with all Python versions with upstream support. Currently, it is tested to work with Python 3.7 to 3.10.

Scheme

The following image illustrates an abstract representation of a time series:

time-series metadata scheme illustration

The scheme contains all metadata to interpret the actual time and quantity values.

It consists of a dictionary containing the following keys with (default) values of the specified type:

metadata = {
    "device_id": string (default: ""),
    "time_name": string (default: "time"),
    "time_unit": string (default: "om:second"),
    "quantity_names": string or list of strings (default: ""),
    "quantity_units": string or list of strings (default: ""),
    "misc": optional, any other data you want to provide (default: None),
}

Example use

We illustrate the use of the scheme assuming you already have a project set up.

Installation

First you need to install the scheme with the usual command into your project's Python virtual environment:

pip install time-series-metadata

Import scheme

Inside your project's code import the scheme at the top of your module.

from time_series_metadata.scheme import MetaData

Assign initial values

After importing the package you can make use of it and assign initial values.

vs_description = MetaData(
    device_id="my_virtual_sensor",
    time_name="time",
    time_unit="s",
    quantity_names=("pressure_1", "pressure_2"),
    quantity_units=("Pa","mPa"),
    misc="additional information"
)

Read out metadata

You can access the metadata as a whole or time and quantity metadata separately. Quantity metadata can be either accessed for all quantities at once or individually via index or name. If you do not specify name or index, the first's quantity metadata is returned. This might be especially convenient, if there is only one quantity.

>>> vs_description.metadata
{"device_id": "my_virtual_sensor", "time_name": "time", "time_unit": "s", "quantity_names": ["pressure_1", "pressure_2"], "quantity_units": ["Pa", "mPa"], "misc": None}
>>> vs_description.time
{'time_name': 'time', 'time_unit': 's'}
>>> vs_description.quantities
{'quantity_names': ('pressure_1', 'pressure_2'), 'quantity_units': ('Pa', 'mPa')}
>>> vs_description.get_quantity(1)
{'quantity_names': 'pressure_2', 'quantity_units': 'mPa'}
>>> vs_description.get_quantity(name="pressure_1")
{'quantity_names': 'pressure_1', 'quantity_units': 'Pa'}
>>> vs_description.get_quantity()
{'quantity_names': 'pressure_1', 'quantity_units': 'Pa'}

Maintainers

The package is developed and maintained at the "Physikalisch-Technische Bundesanstalt" by Maximilian Gruber and Björn Ludwig.