Skip to content

Commit

Permalink
add glossary to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
backmari committed Dec 5, 2024
1 parent 462ed48 commit 450c9e7
Show file tree
Hide file tree
Showing 2 changed files with 78 additions and 0 deletions.
77 changes: 77 additions & 0 deletions docs/glossary.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
Glossary
========

.. glossary::
:sorted:

WebMon
Monitor for instrument status and autoreduction status at SNS and HFIR. WebMon can refer to
either the whole system or the landing page at https://monitor.sns.gov.

DASMON
Data Acquisition System Monitor (DASMON) is a per-beamline service that reports PV values and
experiment/run meta-data to WebMon. Due to the high volume of PV updates, DASMON writes PV
updates straight to the database. DASMON reports its status to WebMon for system diagnostics.

DAS
Data Acquisition System.

SMS
Stream Management Service
Service that aggregates data from fast neutron event data and slow PVs into a data stream
available for both live monitoring and file archiving. SMS reports its status to WebMon for
system diagnostics.

STC
Streaming Translation Client
Service that translates the experiment data stream from SMS to NeXus data file. Triggers the
post-processing workflow after the NeXus file has been created.

PVSD
Process Variable Streaming Daemon
Per-beamline service that subscribes to EPICS Control System PV:s and forwards PV value
changes to the SMS. PVSD reports its status to WebMon for system diagnostics.

PV
Process Variable, for example sample environment variables.

ONCat
Catalog for neutron experiment data at SNS and HFIR: https://oncat.ornl.gov.

SNS
The Spallation Neutron Source at Oak Ridge National Laboratory.

HFIR
The High-Flux Isotope Reactor at Oak Ridge National Laboratory.

NeXuS
Data format for neutron, x-ray, and muon science.

Workflow Manager
Service that orchestrates the autoreduction/post-processing workflow.

Dasmon listener
Service that subscribes to messages from :term:`DASMON` and writes to the database.

Autoreduction
Automated data reduction that can be triggered when the run NeXuS data file is available. The
instrument-specific autoreduction process is configured by the instrument scientist.
Autoreduction is a step in the post-processing workflow.

Cataloging
Cataloging of experiment data in ONCat. Cataloging is a step in the post-processing workflow.

Live Data Server
Service that serves plots to the WebMon front-end. :term:`Livereduce` and
:term:`autoreduction<Autoreduction>` can publish plots for a run to Live Data Server.

Livereduce
Service for live data monitoring of the data stream. Publishes plots to
:term:`Live Data Server`.

IPTS
Experiments/runs are grouped by their Integrated Proposal Tracking System (IPTS) number.

Workflow
Experiment data post-processing workflow. The available tasks are cataloging, autoreduction
and reduced data cataloging.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Welcome to Web Monitor's documentation!
.. toctree::
:maxdepth: 1

glossary
users/index
releasenotes/index
developer/index
Expand Down

0 comments on commit 450c9e7

Please sign in to comment.