Allow use of xedocs context configs (#1125)

* Adds option to context creation function that loads config from xedocs

* Adds context method that applies configs from xedocs

* update docs

Co-authored-by: Yossi Mosbacher <joe.mosbacher>

docs/source/index.rst

@@ -37,6 +37,7 @@ Straxen is the analysis framework for XENONnT, built on top of the generic `stra
     config_storage
     online_monitor
     cmt
+    context_configs
     url_configs
     scada_interface
     tutorials/ScadaInterfaceExample.ipynb

docs/source/xedocs_configs.rst

@@ -0,0 +1,23 @@
+Xedocs context configs
+======================
+
+The xedocs package manages a versioned collection of context configs. 
+This is useful for applying a predefined set of configs to the context in a reproducible way.
+Straxen registers a context method `context.apply_xedocs_configs` which can be used to load and apply 
+the configs from a given version. Example:
+
+.. code-block:: python
+    
+        import straxen
+        st = straxen.contexts.xenonnt()
+        st.apply_xedocs_configs('v9')
+
+
+The straxen context builder function `straxen.contexts.xenonnt` also accepts a `xedocs_version` argument, 
+if passed, straxen will attempt to load all configs from the given version from the xedocs context_configs database.
+Example:
+
+.. code-block:: python
+    
+        import straxen
+        st = straxen.contexts.xenonnt(xedocs_version='v9')

extra_requirements/requirements-tests.txt

@@ -4,3 +4,5 @@ git+https://github.com/XENONnT/ax_env
 wfsim==1.0.2
 nbmake
 pytest-xdist
+xedocs==0.2.4
+

straxen/contexts.py

@@ -89,13 +89,18 @@
 ##
 
 
-def xenonnt(cmt_version='global_ONLINE', _from_cutax=False,  **kwargs):
+def xenonnt(cmt_version='global_ONLINE', xedocs_version=None,
+            _from_cutax=False,  **kwargs):
     """XENONnT context"""
     if not _from_cutax and cmt_version != 'global_ONLINE':
         warnings.warn('Don\'t load a context directly from straxen, '
                       'use cutax instead!')
     st = straxen.contexts.xenonnt_online(**kwargs)
     st.apply_cmt_version(cmt_version)
+
+    if xedocs_version is not None:
+        st.apply_xedocs_configs(xedocs_version)
+
     return st
 
 

straxen/corrections_services.py

@@ -401,6 +401,23 @@ def apply_cmt_version(context: strax.Context, cmt_global_version: str) -> None:
     context.set_config(cmt_config)
 
 
+@strax.Context.add_method
+def apply_xedocs_configs(context: strax.Context, 
+                         version: str, db='straxen_db') -> None:
+    import xedocs
+
+    docs = xedocs.find_docs('context_configs', 
+                            datasource=db, 
+                            version=version)
+
+    global_config = {doc.config_name: doc.value for doc in docs}
+
+    if len(global_config):
+        context.set_config(global_config)
+    else:
+        warnings.warn(f"Could not find any context configs for version {version}")
+
+
 def replace_url_version(url, version):
     """Replace the local version of a correction in a CMT config"""
     kwargs = {k: v[0] for k, v in parse_qs(urlparse(url).query).items()}