xedocs 0.1.27

Top-level package for xedocs.

xedocs is meant to replace cmt and bodega as well as helping tracking all shared documents especially if they need to be versioned.

Basic Usage

Explore the available schemas

import xedocs

>>> xedocs.list_schemas()
>>> ['detector_numbers',
    'fax_configs',
    'plugin_lineages',
    'context_lineages',
    'pmt_gains',
    'global_versions',
    'electron_drift_velocities',
    ...]

>>> xedocs.help('pmt_gains')

>>>
        Schema name: pmt_gains
        Index fields: ['version', 'time', 'detector', 'pmt']
        Column fields: ['created_date', 'comments', 'value']

Read/write data from the staging database, this database is writable from the default analysis username/password

import xedocs

db = xedocs.staging_db(by_category=False)

docs = db.pmt_gains.find_docs(version='v1', pmt=[1,2,3,5], time='2021-01-01T00:00:00', detector='tpc')
gains = [doc.value for doc in docs]

doc = db.pmt_gains.find_one(version='v1', pmt=1, time='2021-01-01T00:00:00', detector='tpc')
pmt1_gain = doc.value

Read from the shared production database, this database is read-only for the default analysis username/password

import xedocs

db = xedocs.production_db(by_category=False)

...

You can also query documents directly from the schema class, Schemas will query the mongodb staging database by default, if no explicit datasource is given.

drift_velocity = xedocs.schemas.DetectorNumber.find_one(field='drift_velocity', version='v1')

# Returns a Bodega object with attributes value, description etc.
drift_velocity.value

all_v1_documents = xedocs.schemas.DetectorNumber.find(version='v1')

Read data from alternative data sources specified by path, e.g csv files which will be loaded by pandas.

import xedocs

g1_doc = xedocs.schemas.DetectorNumber.find_one(datasource='/path/to/file.csv', version='v1', field='g1')
g1_value = g1_doc.value
g1_error = g1_doc.uncertainty

The path can also be a github URL or any other URL supported by fsspec.

import xedocs

g1_doc = xedocs.schemas.DetectorNumber.find_one(
                         datasource='github://org:repo@/path/to/file.csv',
                         version='v1',
                         field='g1')

Supported data sources

• MongoDB collections

• TinyDB tables

• JSON files

• REST API clients

Please open an issue on rframe if you want support for an additional data format.

Documentation

Full documentation hosted by Readthedocs

Credits

This package was created with Cookiecutter and the briggySmalls/cookiecutter-pypackage project template.