documentation updates

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2017-2021, UChicago Argonne, LLC
+Copyright (c) 2017-2022, UChicago Argonne, LLC
 
 All Rights Reserved
 

apstools/__init__.py

@@ -1,7 +1,7 @@
 # -----------------------------------------------------------------------------
 # :author:    Pete R. Jemian
 # :email:     jemian@anl.gov
-# :copyright: (c) 2017-2021, UChicago Argonne, LLC
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
 #
 # Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
 #
@@ -12,7 +12,7 @@
 __description__ = (
     u"Various Python tools for use with the Bluesky Framework at the APS"
 )
-__copyright__ = u"2017-2021, UChicago Argonne, LLC"
+__copyright__ = u"2017-2022, UChicago Argonne, LLC"
 __authors__ = [
     u"Pete Jemian",
 ]

apstools/_devices/__init__.py

@@ -101,3 +101,14 @@
 from .xia_pf4 import Pf4FilterDual
 from .xia_pf4 import Pf4FilterSingle
 from .xia_pf4 import Pf4FilterTriple
+
+
+# -----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
+#
+# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
+#
+# The full license is in the file LICENSE.txt, distributed with this software.
+# -----------------------------------------------------------------------------

apstools/_devices/aps_bss_user.py

@@ -47,3 +47,14 @@ class ApsBssUserInfoDevice(Device):
     esaf = Component(EpicsSignal, "esaf", string=True)
     esaf_contact = Component(EpicsSignal, "esaf_contact", string=True)
     esaf_team = Component(EpicsSignal, "esaf_team", string=True)
+
+
+# -----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
+#
+# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
+#
+# The full license is in the file LICENSE.txt, distributed with this software.
+# -----------------------------------------------------------------------------

apstools/_devices/aps_cycle.py

@@ -163,3 +163,14 @@ def get(self):
         dt = datetime.datetime.now()
         aps_cycle = f"{dt.year}-{int((dt.month-0.1)/4) + 1}"
         return aps_cycle
+
+
+# -----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
+#
+# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
+#
+# The full license is in the file LICENSE.txt, distributed with this software.
+# -----------------------------------------------------------------------------

apstools/_devices/aps_machine.py

@@ -121,3 +121,14 @@ def inUserOperations(self):
             2, "Bm Ln Studies",
         )
         # fmt: on
+
+
+# -----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
+#
+# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
+#
+# The full license is in the file LICENSE.txt, distributed with this software.
+# -----------------------------------------------------------------------------

apstools/_devices/aps_undulator.py

@@ -77,3 +77,14 @@ class ApsUndulatorDual(Device):
 
     upstream = Component(ApsUndulator, "us:")
     downstream = Component(ApsUndulator, "ds:")
+
+
+# -----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
+#
+# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
+#
+# The full license is in the file LICENSE.txt, distributed with this software.
+# -----------------------------------------------------------------------------

apstools/_devices/area_detector_support.py

@@ -530,3 +530,14 @@ def stage(self):
         # from FileStoreHDF5.stage()
         res_kwargs = {"frame_per_point": self.get_frames_per_point()}
         self._generate_resource(res_kwargs)
+
+
+# -----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
+#
+# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
+#
+# The full license is in the file LICENSE.txt, distributed with this software.
+# -----------------------------------------------------------------------------

apstools/_devices/axis_tuner.py

@@ -111,3 +111,14 @@ def tune(self, md=None, **kwargs):
 
             if self.post_tune_method is not None:
                 yield from self.post_tune_method()
+
+
+# -----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
+#
+# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
+#
+# The full license is in the file LICENSE.txt, distributed with this software.
+# -----------------------------------------------------------------------------

apstools/_devices/description_mixin.py

@@ -53,3 +53,14 @@ class EpicsMotorWithMore(
     """
 
     desc = Component(EpicsSignal, ".DESC")
+
+
+# -----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
+#
+# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
+#
+# The full license is in the file LICENSE.txt, distributed with this software.
+# -----------------------------------------------------------------------------

apstools/_devices/kohzu_monochromator.py

@@ -145,3 +145,14 @@ def calibrate_energy(self, value):
         self.use_set.put("Set")
         self.energy.put(value)
         self.use_set.put("Use")
+
+
+# -----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
+#
+# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
+#
+# The full license is in the file LICENSE.txt, distributed with this software.
+# -----------------------------------------------------------------------------

apstools/_devices/linkam_controllers.py

@@ -128,3 +128,14 @@ def __init__(self, *args, **kwargs):
 
         # temperature component is the main value
         self.temperature.name = self.name
+
+
+# -----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
+#
+# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
+#
+# The full license is in the file LICENSE.txt, distributed with this software.
+# -----------------------------------------------------------------------------

apstools/_devices/mixin_base.py

@@ -16,3 +16,14 @@ class DeviceMixinBase(Device):
 
     .. index:: Ophyd Device Mixin; DeviceMixinBase
     """
+
+
+# -----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
+#
+# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
+#
+# The full license is in the file LICENSE.txt, distributed with this software.
+# -----------------------------------------------------------------------------

apstools/_devices/motor_mixins.py

@@ -226,3 +226,14 @@ class myEpicsMotor(EpicsMotorResolutionMixin, EpicsMotor): pass
     resolution = Component(EpicsSignal, ".MRES", kind="omitted")
     steps_per_rev = Component(EpicsSignal, ".SREV", kind="omitted")
     units_per_rev = Component(EpicsSignal, ".UREV", kind="omitted")
+
+
+# -----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
+#
+# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
+#
+# The full license is in the file LICENSE.txt, distributed with this software.
+# -----------------------------------------------------------------------------

apstools/_devices/positioner_soft_done.py

@@ -205,3 +205,14 @@ def stop(self, *, success=False):
         """
         if not self.inposition:
             self.setpoint.put(self.position)
+
+
+# -----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
+#
+# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
+#
+# The full license is in the file LICENSE.txt, distributed with this software.
+# -----------------------------------------------------------------------------

apstools/_devices/preamp_base.py

@@ -9,7 +9,7 @@
 # -----------------------------------------------------------------------------
 # :author:    Pete R. Jemian
 # :email:     jemian@anl.gov
-# :copyright: (c) 2017-2021, UChicago Argonne, LLC
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
 #
 # Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
 #
@@ -33,3 +33,14 @@ class PreamplifierBaseDevice(Device):
     """
 
     gain = Component(Signal, kind="normal", value=1)
+
+
+# -----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
+#
+# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
+#
+# The full license is in the file LICENSE.txt, distributed with this software.
+# -----------------------------------------------------------------------------

apstools/_devices/ptc10_controller.py

@@ -164,3 +164,14 @@ def stop(self, *, success=False):
         """
         if not self.done.get():
             self.setpoint.put(self.position)
+
+
+# -----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
+#
+# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
+#
+# The full license is in the file LICENSE.txt, distributed with this software.
+# -----------------------------------------------------------------------------

apstools/_devices/scaler_support.py

@@ -44,3 +44,14 @@ def use_EPICS_scaler_channels(scaler):
                 configuration_attrs.append(ch + ".gate")
         scaler.channels.read_attrs = read_attrs
         scaler.channels.configuration_attrs = configuration_attrs
+
+
+# -----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
+#
+# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
+#
+# The full license is in the file LICENSE.txt, distributed with this software.
+# -----------------------------------------------------------------------------

apstools/_devices/shutters.py

@@ -731,3 +731,14 @@ def planA():
     """
 
     signal = Component(EpicsSignal, "")
+
+
+# -----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
+#
+# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
+#
+# The full license is in the file LICENSE.txt, distributed with this software.
+# -----------------------------------------------------------------------------

apstools/_devices/srs570_preamplifier.py

@@ -19,7 +19,7 @@
 # -----------------------------------------------------------------------------
 # :author:    Pete R. Jemian
 # :email:     jemian@anl.gov
-# :copyright: (c) 2017-2021, UChicago Argonne, LLC
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
 #
 # Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
 #

apstools/_devices/struck3820.py

@@ -52,3 +52,14 @@ class Struck3820(Device):
     output_polarity = Component(EpicsSignal, "OutputPolarity")
     read_rate = Component(EpicsSignal, "ReadAll.SCAN")
     do_readl_all = Component(EpicsSignal, "DoReadAll")
+
+
+# -----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
+#
+# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
+#
+# The full license is in the file LICENSE.txt, distributed with this software.
+# -----------------------------------------------------------------------------

apstools/_devices/tracking_signal.py

@@ -30,3 +30,14 @@ def check_value(self, value):
         """
         if not isinstance(value, bool):
             raise ValueError("tracking is boolean, it can only be True or False.")
+
+
+# -----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
+#
+# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
+#
+# The full license is in the file LICENSE.txt, distributed with this software.
+# -----------------------------------------------------------------------------

apstools/_devices/xia_pf4.py

@@ -148,3 +148,14 @@ class DualPf4FilterBox(Device):
     energy_keV_local = Component(EpicsSignal, "E:local")
     energy_keV_mono = Component(EpicsSignal, "displayEnergy")
     mode = Component(EpicsSignal, "useMono", string=True)
+
+
+# -----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
+#
+# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
+#
+# The full license is in the file LICENSE.txt, distributed with this software.
+# -----------------------------------------------------------------------------

apstools/_plans/doc_run.py

@@ -84,3 +84,14 @@ def documentation_run(text, stream=None, bec=None, md=None):
         bec.enable_plots()
 
     return uid
+
+
+# -----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
+#
+# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
+#
+# The full license is in the file LICENSE.txt, distributed with this software.
+# -----------------------------------------------------------------------------

apstools/_requirements.py

@@ -1,7 +1,7 @@
 # -----------------------------------------------------------------------------
 # :author:    Pete R. Jemian
 # :email:     jemian@anl.gov
-# :copyright: (c) 2017-2021, UChicago Argonne, LLC
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
 #
 # Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
 #

apstools/_utils/device_info.py

@@ -275,3 +275,14 @@ def sorter(obj):
     if printing:
         print(t.reST(fmt=fmt))
     return t
+
+
+# -----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
+#
+# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
+#
+# The full license is in the file LICENSE.txt, distributed with this software.
+# -----------------------------------------------------------------------------

apstools/_utils/list_plans.py

@@ -75,3 +75,14 @@ def listplans(base=None, trunc=40):
             dd["plan"].append(f"{prefix}{key}")
             dd["doc"].append(doc)
     return pd.DataFrame(dd)
+
+
+# -----------------------------------------------------------------------------
+# :author:    Pete R. Jemian
+# :email:     jemian@anl.gov
+# :copyright: (c) 2017-2022, UChicago Argonne, LLC
+#
+# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
+#
+# The full license is in the file LICENSE.txt, distributed with this software.
+# -----------------------------------------------------------------------------