Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add scada interface to docs #560

Merged
merged 9 commits into from
Jun 23, 2021
Merged

Add scada interface to docs #560

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
2fd64d2
Changed start/end time check to log10
WenzDaniel Jun 17, 2021
92d4a76
Added documentation for SCADA interface.
WenzDaniel Jun 17, 2021
d2b3b35
Added scadainterface docs
WenzDaniel Jun 22, 2021
963fa1c
Merge branch 'master' into add_scada_interface_to_docs
WenzDaniel Jun 22, 2021
34e370b
Greater should have been smaller
WenzDaniel Jun 22, 2021
46c55a3
Merge branch 'add_scada_interface_to_docs' of https://github.com/XENO…
WenzDaniel Jun 22, 2021
b19a66d
Move notebook to notebooks tutorials
WenzDaniel Jun 23, 2021
81f246e
Merge branch 'add_scada_interface_to_docs' of https://github.com/XENO…
WenzDaniel Jun 23, 2021
09f16bf
Added softlink and updated docs
WenzDaniel Jun 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,12 @@ Straxen is the analysis framework for XENONnT, built on top of the generic `stra
scripts
bootstrax

.. toctree::
:maxdepth: 2
:caption: Auxilliary tools

scada_interface
tutorials/ScadaInterfaceExample.ipynb

.. toctree::
:maxdepth: 1
Expand Down
41 changes: 40 additions & 1 deletion docs/source/reference/straxen.analyses.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,30 @@ straxen.analyses package
Submodules
WenzDaniel marked this conversation as resolved.
Show resolved Hide resolved
----------

straxen.analyses.bokeh\_waveform\_plot module
---------------------------------------------

.. automodule:: straxen.analyses.bokeh_waveform_plot
:members:
:undoc-members:
:show-inheritance:

straxen.analyses.daq\_waveforms module
--------------------------------------

.. automodule:: straxen.analyses.daq_waveforms
:members:
:undoc-members:
:show-inheritance:

straxen.analyses.event\_display module
--------------------------------------

.. automodule:: straxen.analyses.event_display
:members:
:undoc-members:
:show-inheritance:

straxen.analyses.holoviews\_waveform\_display module
----------------------------------------------------

Expand All @@ -12,6 +36,22 @@ straxen.analyses.holoviews\_waveform\_display module
:undoc-members:
:show-inheritance:

straxen.analyses.posrec\_comparison module
------------------------------------------

.. automodule:: straxen.analyses.posrec_comparison
:members:
:undoc-members:
:show-inheritance:

straxen.analyses.pulse\_plots module
------------------------------------

.. automodule:: straxen.analyses.pulse_plots
:members:
:undoc-members:
:show-inheritance:

straxen.analyses.quick\_checks module
-------------------------------------

Expand All @@ -36,7 +76,6 @@ straxen.analyses.waveform\_plot module
:undoc-members:
:show-inheritance:


Module contents
---------------

Expand Down
97 changes: 96 additions & 1 deletion docs/source/reference/straxen.plugins.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ straxen.plugins package
Submodules
----------

straxen.plugins.acqmon\_processing module
-----------------------------------------

.. automodule:: straxen.plugins.acqmon_processing
:members:
:undoc-members:
:show-inheritance:

straxen.plugins.daqreader module
--------------------------------

Expand All @@ -12,6 +20,30 @@ straxen.plugins.daqreader module
:undoc-members:
:show-inheritance:

straxen.plugins.double\_scatter module
--------------------------------------

.. automodule:: straxen.plugins.double_scatter
:members:
:undoc-members:
:show-inheritance:

straxen.plugins.event\_area\_per\_channel module
------------------------------------------------

.. automodule:: straxen.plugins.event_area_per_channel
:members:
:undoc-members:
:show-inheritance:

straxen.plugins.event\_patternfit module
----------------------------------------

.. automodule:: straxen.plugins.event_patternfit
:members:
:undoc-members:
:show-inheritance:

straxen.plugins.event\_processing module
----------------------------------------

Expand All @@ -20,6 +52,30 @@ straxen.plugins.event\_processing module
:undoc-members:
:show-inheritance:

straxen.plugins.led\_calibration module
---------------------------------------

.. automodule:: straxen.plugins.led_calibration
:members:
:undoc-members:
:show-inheritance:

straxen.plugins.nveto\_recorder module
--------------------------------------

.. automodule:: straxen.plugins.nveto_recorder
:members:
:undoc-members:
:show-inheritance:

straxen.plugins.online\_monitor module
--------------------------------------

.. automodule:: straxen.plugins.online_monitor
:members:
:undoc-members:
:show-inheritance:

straxen.plugins.pax\_interface module
-------------------------------------

Expand All @@ -44,6 +100,14 @@ straxen.plugins.peaklet\_processing module
:undoc-members:
:show-inheritance:

straxen.plugins.position\_reconstruction module
-----------------------------------------------

.. automodule:: straxen.plugins.position_reconstruction
:members:
:undoc-members:
:show-inheritance:

straxen.plugins.pulse\_processing module
----------------------------------------

Expand All @@ -52,6 +116,38 @@ straxen.plugins.pulse\_processing module
:undoc-members:
:show-inheritance:

straxen.plugins.veto\_events module
-----------------------------------

.. automodule:: straxen.plugins.veto_events
:members:
:undoc-members:
:show-inheritance:

straxen.plugins.veto\_hitlets module
------------------------------------

.. automodule:: straxen.plugins.veto_hitlets
:members:
:undoc-members:
:show-inheritance:

straxen.plugins.veto\_pulse\_processing module
----------------------------------------------

.. automodule:: straxen.plugins.veto_pulse_processing
:members:
:undoc-members:
:show-inheritance:

straxen.plugins.veto\_veto\_regions module
------------------------------------------

.. automodule:: straxen.plugins.veto_veto_regions
:members:
:undoc-members:
:show-inheritance:

straxen.plugins.x1t\_cuts module
--------------------------------

Expand All @@ -60,7 +156,6 @@ straxen.plugins.x1t\_cuts module
:undoc-members:
:show-inheritance:


Module contents
---------------

Expand Down
52 changes: 42 additions & 10 deletions docs/source/reference/straxen.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,22 @@ Subpackages
-----------

.. toctree::
:maxdepth: 4

straxen.analyses
straxen.plugins

Submodules
----------

straxen.bokeh\_utils module
---------------------------

.. automodule:: straxen.bokeh_utils
:members:
:undoc-members:
:show-inheritance:

straxen.common module
---------------------

Expand All @@ -29,69 +38,93 @@ straxen.contexts module
:show-inheritance:

straxen.corrections\_services module
-------------------------------------------
------------------------------------

.. automodule:: straxen.corrections_services
:members:
:undoc-members:
:show-inheritance:

straxen.get\_corrections module
-----------------------------------------
-------------------------------

.. automodule:: straxen.get_corrections
:members:
:undoc-members:
:show-inheritance:

straxen.hitfinder\_thresholds
-------------------------------------------
straxen.hitfinder\_thresholds module
------------------------------------

.. automodule:: straxen.hitfinder_thresholds
:members:
:undoc-members:
:show-inheritance:

straxen.holoviews\_utils module
-------------------------------

.. automodule:: straxen.holoviews_utils
:members:
:undoc-members:
:show-inheritance:

straxen.itp\_map module
-------------------------------------------
-----------------------

.. automodule:: straxen.itp_map
:members:
:undoc-members:
:show-inheritance:

straxen.matplotlib\_utils module
---------------------------------------
--------------------------------

.. automodule:: straxen.matplotlib_utils
:members:
:undoc-members:
:show-inheritance:

straxen.mini\_analysis module
------------------------------------
-----------------------------

.. automodule:: straxen.mini_analysis
:members:
:undoc-members:
:show-inheritance:

straxen.misc module
-------------------

.. automodule:: straxen.misc
:members:
:undoc-members:
:show-inheritance:

straxen.mongo\_storage module
------------------------------------
-----------------------------

.. automodule:: straxen.mongo_storage
:members:
:undoc-members:
:show-inheritance:

straxen.online\_monitor module
------------------------------------
------------------------------

.. automodule:: straxen.online_monitor
:members:
:undoc-members:
:show-inheritance:

straxen.rucio module
--------------------

.. automodule:: straxen.rucio
:members:
:undoc-members:
:show-inheritance:

straxen.rundb module
--------------------

Expand All @@ -116,7 +149,6 @@ straxen.units module
:undoc-members:
:show-inheritance:


Module contents
---------------

Expand Down
8 changes: 8 additions & 0 deletions docs/source/scada_interface.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
SCADA Interface
===============
The SCADA Interface is a XENONnT specific tool which allows analysers and other tools to communicate
with our slow control database. The communication is done via different `webservice tools`_ provided
by the slow control team. Slow control data can be only accessed via midway. A little tutorial
notebook about the interface can be found in the subsequent notebook.

.. _webservice tools: https://xe1t-wiki.lngs.infn.it/doku.php?id=xenon:xenon1t:slowcontrol:webserviceNew
Loading