Auto-update from Github Actions Workflow

Deployed from commit 4c37c88 (refs/heads/master) Deployed from commit b978c6e (refs/heads/master) Deployed from commit 3e22a18 (refs/heads/master) Deployed from commit 0b8e032 (refs/heads/master) Deployed from commit 0828548 (refs/heads/master)
pcdshub · Dec 20, 2024 · d4a35c0 · d4a35c0
1 parent 9627ab1
commit d4a35c0
Show file tree

Hide file tree

Showing 104 changed files with 1,379 additions and 1,369 deletions.
diff --git a/master/.buildinfo b/master/.buildinfo
diff --git a/master/_sources/releases.rst.txt b/master/_sources/releases.rst.txt
@@ -2,6 +2,47 @@ Release History
 ###############
 
 
+v1.22.0 (2024-12-19)
+====================
+
+Features
+--------
+- Add ``pcdscalc.xray`` to the calc namespace.
+- Add top-level shortcuts to some of the most used calcs,
+  ``E2lam``, ``lam2E``, ``bragg_angle``, ``darwin_width``,
+  and ``transmission``.
+  ``E2lam`` is an alias for ``energy_to_wavelength`` and
+  ``lam2E`` is an alias for ``wavelength_to_energy``
+  to match scientist expectations.
+- Added ability to ignore specific upstream devices when loading hutch-python.
+
+  - ``UPSTREAM``: The hutch's devices, and devices upstream from the requested hutch.
+    If there are multiple paths to the requested hutch, all paths devices are loaded.
+  - ``STANDARD``: Devices gathered via ``UPSTREAM``, plus devices that share the
+    "beamline" field in happi with the ``UPSTREAM`` devices.  (The current standard)
+  - ``ALL``: All devices in the happi database.  Use this option at your own risk.
+
+
+Bugfixes
+--------
+- Make test_create_arg agnostic to where pytest was invoked from
+- Fix an issue where the user could clobber their own ``elog``
+  object in a way that would allow the ``ElogPoster`` utility to
+  load and then fail at scan time.
+
+Maintenance
+-----------
+- Updates documentation formatting for device load_level, and adds an ascii beamline map to the test suite
+
+Contributors
+------------
+- janeliu-slac
+- tangkong
+- vespos
+- zllentz
+
+
+
 v1.21.0 (2024-08-20)
 ====================
 

diff --git a/master/_sources/yaml_files.rst.txt b/master/_sources/yaml_files.rst.txt
@@ -4,7 +4,7 @@ Yaml Files
 ``hutch-python`` uses a ``conf.yml`` file for basic configuration. This is a
 standard yaml file with the following valid keys:
 ``hutch``, ``db``, ``load``, ``load_level``, ``experiment``, ``obj_config``,
-``daq_type``, ``daq_host``, and ``daq_platform``.
+``daq_type``, ``daq_host``, and ``daq_platform``, ``exclude_devices``.
 
 
 hutch
@@ -75,9 +75,11 @@ The ``load_level`` key expects one of the following strings, corresponding to th
 amount of ophyd devices to load:
 
 - ``UPSTREAM``: The hutch's devices, and devices upstream from the requested hutch.
-If there are multiple paths to the requested hutch, all paths' devices are loaded.
+  If there are multiple paths to the requested hutch, all paths' devices are loaded.
+
 - ``STANDARD``: Devices gathered via ``UPSTREAM``, plus devices that share the
-"beamline" field in happi with the ``UPSTREAM`` devices.  (The current standard)
+  "beamline" field in happi with the ``UPSTREAM`` devices.  (The current standard)
+
 - ``ALL``: All devices in the happi database.  Use this option at your own risk.
 
 .. code-block:: YAML
@@ -104,6 +106,7 @@ particular experiment.
 
 .. _obj_conf_yaml:
 
+
 obj_conf
 --------
 
@@ -135,13 +138,15 @@ This key expects a string with one of four valid values:
 LCLS1-style daq, a simulated LCLS1-style daq, an LCLS2-style daq,
 or no daq respectively.
 
+
 daq_host
 --------
 
 The daq collection host as a string. This is a required key
 when using the lcls2 daq_type, and is ignored with any other daq_type.
 It will be used in the creation of the lcls2 daq object.
 
+
 daq_platform
 ------------
 
@@ -155,6 +160,26 @@ experiment. Additional keys are interpreted as hostnames to use
 alternate platforms for. Alternate platforms will post to the
 secondary elog.
 
+
+exclude_devices
+------------
+The ``exclude_devices`` key is optional. ``exclude_devices`` expects a list
+of strings containing names of upstream devices that should not be loaded.
+It reduces the amount of unnecessary information shown in the console at
+load time. The list can be created as a multi-line array of strings or all
+on one line using the following formats:
+
+.. code-block:: YAML
+
+   exclude_devices:
+      - crix_cryo_y
+      - at2k2_calc
+
+.. code-block:: YAML
+
+   exclude_devices: ['crix_cryo_y', 'at2k2_calc']
+
+
 Full File Example
 -----------------
 

diff --git a/master/_static/css/badge_only.css b/master/_static/css/badge_only.css
diff --git a/master/_static/css/theme.css b/master/_static/css/theme.css
diff --git a/master/_static/documentation_options.js b/master/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '1.20.1.dev80+g1185e270',
+    VERSION: '1.21.1.dev49+g0828548e',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/master/_static/fonts/Lato/lato-bold.eot b/master/_static/fonts/Lato/lato-bold.eot
diff --git a/master/_static/fonts/Lato/lato-bold.ttf b/master/_static/fonts/Lato/lato-bold.ttf
diff --git a/master/_static/fonts/Lato/lato-bold.woff b/master/_static/fonts/Lato/lato-bold.woff
diff --git a/master/_static/fonts/Lato/lato-bold.woff2 b/master/_static/fonts/Lato/lato-bold.woff2
diff --git a/master/_static/fonts/Lato/lato-bolditalic.eot b/master/_static/fonts/Lato/lato-bolditalic.eot
diff --git a/master/_static/fonts/Lato/lato-bolditalic.ttf b/master/_static/fonts/Lato/lato-bolditalic.ttf
diff --git a/master/_static/fonts/Lato/lato-bolditalic.woff b/master/_static/fonts/Lato/lato-bolditalic.woff
diff --git a/master/_static/fonts/Lato/lato-bolditalic.woff2 b/master/_static/fonts/Lato/lato-bolditalic.woff2
diff --git a/master/_static/fonts/Lato/lato-italic.eot b/master/_static/fonts/Lato/lato-italic.eot
diff --git a/master/_static/fonts/Lato/lato-italic.ttf b/master/_static/fonts/Lato/lato-italic.ttf
diff --git a/master/_static/fonts/Lato/lato-italic.woff b/master/_static/fonts/Lato/lato-italic.woff
diff --git a/master/_static/fonts/Lato/lato-italic.woff2 b/master/_static/fonts/Lato/lato-italic.woff2
diff --git a/master/_static/fonts/Lato/lato-regular.eot b/master/_static/fonts/Lato/lato-regular.eot
diff --git a/master/_static/fonts/Lato/lato-regular.ttf b/master/_static/fonts/Lato/lato-regular.ttf
diff --git a/master/_static/fonts/Lato/lato-regular.woff b/master/_static/fonts/Lato/lato-regular.woff
diff --git a/master/_static/fonts/Lato/lato-regular.woff2 b/master/_static/fonts/Lato/lato-regular.woff2
diff --git a/master/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot b/master/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot
diff --git a/master/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf b/master/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf
diff --git a/master/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff b/master/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff
diff --git a/master/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 b/master/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2
diff --git a/master/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot b/master/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot
diff --git a/master/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf b/master/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf
diff --git a/master/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff b/master/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff
diff --git a/master/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 b/master/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2
diff --git a/master/_static/js/html5shiv-printshiv.min.js b/master/_static/js/html5shiv-printshiv.min.js
diff --git a/master/_static/js/html5shiv.min.js b/master/_static/js/html5shiv.min.js