From aa526c2a1e590b3245d5e0c327d3ef3df85eb92f Mon Sep 17 00:00:00 2001 From: Pete R Jemian Date: Fri, 26 Nov 2021 20:59:18 -0600 Subject: [PATCH 1/3] FIX #585 --- LICENSE.txt | 2 +- apstools/__init__.py | 4 ++-- apstools/_devices/preamp_base.py | 2 +- apstools/_devices/srs570_preamplifier.py | 2 +- apstools/_requirements.py | 2 +- apstools/_utils/tests/__init__.py | 2 +- apstools/callbacks.py | 2 +- apstools/devices.py | 2 +- apstools/examples.py | 2 +- apstools/filewriters.py | 2 +- apstools/migration/spec2ophyd.py | 2 +- apstools/migration/tests/__init__.py | 2 +- apstools/migration/tests/test_spec2ophyd.py | 1 - apstools/plans.py | 2 +- apstools/pss_shutter.db | 2 +- apstools/run_snapshot.py | 2 +- apstools/run_snapshot_gui.py | 2 +- apstools/signals.py | 2 +- apstools/snapshot.py | 2 +- apstools/synApps/__init__.py | 2 +- apstools/synApps/_common.py | 2 +- apstools/synApps/asyn.py | 2 +- apstools/synApps/busy.py | 2 +- apstools/synApps/calcout.py | 2 +- apstools/synApps/epid.py | 2 +- apstools/synApps/iocstats.py | 2 +- apstools/synApps/save_data.py | 2 +- apstools/synApps/sscan.py | 2 +- apstools/synApps/swait.py | 2 +- apstools/synApps/transform.py | 2 +- apstools/tests/__init__.py | 2 +- apstools/tests/test_filewriter.py | 1 + apstools/utils.py | 2 +- docs/source/index.rst | 2 +- 34 files changed, 34 insertions(+), 34 deletions(-) diff --git a/LICENSE.txt b/LICENSE.txt index 032f8119f..824d832a7 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,4 +1,4 @@ -Copyright (c) 2017-2021, UChicago Argonne, LLC +Copyright (c) 2017-2022, UChicago Argonne, LLC All Rights Reserved diff --git a/apstools/__init__.py b/apstools/__init__.py index f74088dd2..f67c820b8 100644 --- a/apstools/__init__.py +++ b/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", ] diff --git a/apstools/_devices/preamp_base.py b/apstools/_devices/preamp_base.py index 4fcd393aa..502ea1975 100644 --- a/apstools/_devices/preamp_base.py +++ b/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. # diff --git a/apstools/_devices/srs570_preamplifier.py b/apstools/_devices/srs570_preamplifier.py index 9900c79fa..b268b575e 100644 --- a/apstools/_devices/srs570_preamplifier.py +++ b/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. # diff --git a/apstools/_requirements.py b/apstools/_requirements.py index d78516850..4f5f08644 100644 --- a/apstools/_requirements.py +++ b/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. # diff --git a/apstools/_utils/tests/__init__.py b/apstools/_utils/tests/__init__.py index 41e4e66c8..37233b1cb 100644 --- a/apstools/_utils/tests/__init__.py +++ b/apstools/_utils/tests/__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. # diff --git a/apstools/callbacks.py b/apstools/callbacks.py index b34536084..3290176da 100644 --- a/apstools/callbacks.py +++ b/apstools/callbacks.py @@ -16,7 +16,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. # diff --git a/apstools/devices.py b/apstools/devices.py index 571052e67..9a02f968c 100644 --- a/apstools/devices.py +++ b/apstools/devices.py @@ -104,7 +104,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. # diff --git a/apstools/examples.py b/apstools/examples.py index a59d9c54a..aa6700188 100755 --- a/apstools/examples.py +++ b/apstools/examples.py @@ -12,7 +12,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. # diff --git a/apstools/filewriters.py b/apstools/filewriters.py index f53e2c5c2..276bf2f6d 100644 --- a/apstools/filewriters.py +++ b/apstools/filewriters.py @@ -17,7 +17,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. # diff --git a/apstools/migration/spec2ophyd.py b/apstools/migration/spec2ophyd.py index 736759d46..445b4de4b 100755 --- a/apstools/migration/spec2ophyd.py +++ b/apstools/migration/spec2ophyd.py @@ -32,7 +32,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. # diff --git a/apstools/migration/tests/__init__.py b/apstools/migration/tests/__init__.py index 41e4e66c8..37233b1cb 100644 --- a/apstools/migration/tests/__init__.py +++ b/apstools/migration/tests/__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. # diff --git a/apstools/migration/tests/test_spec2ophyd.py b/apstools/migration/tests/test_spec2ophyd.py index e8a184a48..d0293b16e 100644 --- a/apstools/migration/tests/test_spec2ophyd.py +++ b/apstools/migration/tests/test_spec2ophyd.py @@ -1,7 +1,6 @@ import pytest from apstools.migration import spec2ophyd import os -# import sys from collections import OrderedDict path = os.path.abspath(os.path.join(os.path.dirname(__file__), "..")) diff --git a/apstools/plans.py b/apstools/plans.py index 91df254f7..c79626e95 100644 --- a/apstools/plans.py +++ b/apstools/plans.py @@ -24,7 +24,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. # diff --git a/apstools/pss_shutter.db b/apstools/pss_shutter.db index 0b3669102..afe4ee78d 100644 --- a/apstools/pss_shutter.db +++ b/apstools/pss_shutter.db @@ -6,7 +6,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. # diff --git a/apstools/run_snapshot.py b/apstools/run_snapshot.py index 57dcc8be3..b8540b19e 100755 --- a/apstools/run_snapshot.py +++ b/apstools/run_snapshot.py @@ -7,7 +7,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. # diff --git a/apstools/run_snapshot_gui.py b/apstools/run_snapshot_gui.py index b324e78e8..5ee2370b7 100755 --- a/apstools/run_snapshot_gui.py +++ b/apstools/run_snapshot_gui.py @@ -7,7 +7,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. # diff --git a/apstools/signals.py b/apstools/signals.py index ef9a95bb0..aa26919af 100644 --- a/apstools/signals.py +++ b/apstools/signals.py @@ -10,7 +10,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. # diff --git a/apstools/snapshot.py b/apstools/snapshot.py index 3345bc2ba..3fdd503ea 100755 --- a/apstools/snapshot.py +++ b/apstools/snapshot.py @@ -30,7 +30,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. # diff --git a/apstools/synApps/__init__.py b/apstools/synApps/__init__.py index 18ea612c4..6a484f15d 100644 --- a/apstools/synApps/__init__.py +++ b/apstools/synApps/__init__.py @@ -25,7 +25,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. # diff --git a/apstools/synApps/_common.py b/apstools/synApps/_common.py index 03a8efe17..b53f3ec37 100644 --- a/apstools/synApps/_common.py +++ b/apstools/synApps/_common.py @@ -18,7 +18,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. # diff --git a/apstools/synApps/asyn.py b/apstools/synApps/asyn.py index 3746e14d0..95f8ff4ce 100644 --- a/apstools/synApps/asyn.py +++ b/apstools/synApps/asyn.py @@ -13,7 +13,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. # diff --git a/apstools/synApps/busy.py b/apstools/synApps/busy.py index 7528f2f2c..530debd86 100644 --- a/apstools/synApps/busy.py +++ b/apstools/synApps/busy.py @@ -13,7 +13,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. # diff --git a/apstools/synApps/calcout.py b/apstools/synApps/calcout.py index 0e50e3a80..d92f1e30e 100644 --- a/apstools/synApps/calcout.py +++ b/apstools/synApps/calcout.py @@ -18,7 +18,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. # diff --git a/apstools/synApps/epid.py b/apstools/synApps/epid.py index 2f132477b..82029b3f6 100644 --- a/apstools/synApps/epid.py +++ b/apstools/synApps/epid.py @@ -14,7 +14,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. # diff --git a/apstools/synApps/iocstats.py b/apstools/synApps/iocstats.py index 1ef65ce68..b6142b062 100644 --- a/apstools/synApps/iocstats.py +++ b/apstools/synApps/iocstats.py @@ -13,7 +13,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. # diff --git a/apstools/synApps/save_data.py b/apstools/synApps/save_data.py index 61d622ce3..319966aa5 100644 --- a/apstools/synApps/save_data.py +++ b/apstools/synApps/save_data.py @@ -20,7 +20,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. # diff --git a/apstools/synApps/sscan.py b/apstools/synApps/sscan.py index c39711d94..6450401d4 100644 --- a/apstools/synApps/sscan.py +++ b/apstools/synApps/sscan.py @@ -30,7 +30,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. # diff --git a/apstools/synApps/swait.py b/apstools/synApps/swait.py index b74dc30d5..21bf05c33 100644 --- a/apstools/synApps/swait.py +++ b/apstools/synApps/swait.py @@ -30,7 +30,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. # diff --git a/apstools/synApps/transform.py b/apstools/synApps/transform.py index 49167298f..2161c36f5 100644 --- a/apstools/synApps/transform.py +++ b/apstools/synApps/transform.py @@ -13,7 +13,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. # diff --git a/apstools/tests/__init__.py b/apstools/tests/__init__.py index 41e4e66c8..37233b1cb 100644 --- a/apstools/tests/__init__.py +++ b/apstools/tests/__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. # diff --git a/apstools/tests/test_filewriter.py b/apstools/tests/test_filewriter.py index 94d01acd1..264a4fb3f 100644 --- a/apstools/tests/test_filewriter.py +++ b/apstools/tests/test_filewriter.py @@ -1,6 +1,7 @@ """ unit tests for the filewriters """ + import databroker import h5py import os diff --git a/apstools/utils.py b/apstools/utils.py index 1a033b087..c1adf0484 100644 --- a/apstools/utils.py +++ b/apstools/utils.py @@ -65,7 +65,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. # diff --git a/docs/source/index.rst b/docs/source/index.rst index e33cd6ec6..8cd9c602c 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -22,7 +22,7 @@ Package Information ============= ======================================== version |version| published |today| -copyright 2017-2020, UChicago Argonne, LLC +copyright 2017-2022, UChicago Argonne, LLC license ANL OPEN SOURCE LICENSE (see LICENSE.txt file) author Pete R. Jemian ============= ======================================== From b172258c5200c3049fe63b92bb32474d4340c9c8 Mon Sep 17 00:00:00 2001 From: Pete R Jemian Date: Fri, 26 Nov 2021 21:04:57 -0600 Subject: [PATCH 2/3] MNT #585 copyright all .py files --- apstools/_devices/__init__.py | 11 +++++++++++ apstools/_devices/aps_bss_user.py | 11 +++++++++++ apstools/_devices/aps_cycle.py | 11 +++++++++++ apstools/_devices/aps_machine.py | 11 +++++++++++ apstools/_devices/aps_undulator.py | 11 +++++++++++ apstools/_devices/area_detector_support.py | 11 +++++++++++ apstools/_devices/axis_tuner.py | 11 +++++++++++ apstools/_devices/description_mixin.py | 11 +++++++++++ apstools/_devices/kohzu_monochromator.py | 11 +++++++++++ apstools/_devices/linkam_controllers.py | 11 +++++++++++ apstools/_devices/mixin_base.py | 11 +++++++++++ apstools/_devices/motor_mixins.py | 11 +++++++++++ apstools/_devices/positioner_soft_done.py | 11 +++++++++++ apstools/_devices/preamp_base.py | 11 +++++++++++ apstools/_devices/ptc10_controller.py | 11 +++++++++++ apstools/_devices/scaler_support.py | 11 +++++++++++ apstools/_devices/shutters.py | 11 +++++++++++ apstools/_devices/struck3820.py | 11 +++++++++++ apstools/_devices/tracking_signal.py | 11 +++++++++++ apstools/_devices/xia_pf4.py | 11 +++++++++++ apstools/_plans/doc_run.py | 11 +++++++++++ apstools/_utils/device_info.py | 11 +++++++++++ apstools/_utils/list_plans.py | 11 +++++++++++ apstools/_utils/override_parameters.py | 11 +++++++++++ setup.py | 11 +++++++++++ 25 files changed, 275 insertions(+) diff --git a/apstools/_devices/__init__.py b/apstools/_devices/__init__.py index c17356321..42a0a8de7 100644 --- a/apstools/_devices/__init__.py +++ b/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. +# ----------------------------------------------------------------------------- diff --git a/apstools/_devices/aps_bss_user.py b/apstools/_devices/aps_bss_user.py index 5547e7f9e..91e029252 100644 --- a/apstools/_devices/aps_bss_user.py +++ b/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. +# ----------------------------------------------------------------------------- diff --git a/apstools/_devices/aps_cycle.py b/apstools/_devices/aps_cycle.py index 7f1b39c82..07fdd22c3 100644 --- a/apstools/_devices/aps_cycle.py +++ b/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. +# ----------------------------------------------------------------------------- diff --git a/apstools/_devices/aps_machine.py b/apstools/_devices/aps_machine.py index 9a54618cc..754894b61 100644 --- a/apstools/_devices/aps_machine.py +++ b/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. +# ----------------------------------------------------------------------------- diff --git a/apstools/_devices/aps_undulator.py b/apstools/_devices/aps_undulator.py index f441ef48f..46faf0160 100644 --- a/apstools/_devices/aps_undulator.py +++ b/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. +# ----------------------------------------------------------------------------- diff --git a/apstools/_devices/area_detector_support.py b/apstools/_devices/area_detector_support.py index dd063b87d..7d96f9682 100644 --- a/apstools/_devices/area_detector_support.py +++ b/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. +# ----------------------------------------------------------------------------- diff --git a/apstools/_devices/axis_tuner.py b/apstools/_devices/axis_tuner.py index 4ff65a67d..d9e76ef06 100644 --- a/apstools/_devices/axis_tuner.py +++ b/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. +# ----------------------------------------------------------------------------- diff --git a/apstools/_devices/description_mixin.py b/apstools/_devices/description_mixin.py index b566cfb67..4ab5e1185 100644 --- a/apstools/_devices/description_mixin.py +++ b/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. +# ----------------------------------------------------------------------------- diff --git a/apstools/_devices/kohzu_monochromator.py b/apstools/_devices/kohzu_monochromator.py index 84bf33494..1c82d0729 100644 --- a/apstools/_devices/kohzu_monochromator.py +++ b/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. +# ----------------------------------------------------------------------------- diff --git a/apstools/_devices/linkam_controllers.py b/apstools/_devices/linkam_controllers.py index 94c5099c5..e8d26ef33 100644 --- a/apstools/_devices/linkam_controllers.py +++ b/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. +# ----------------------------------------------------------------------------- diff --git a/apstools/_devices/mixin_base.py b/apstools/_devices/mixin_base.py index 10b1d2d72..f1dd498a3 100644 --- a/apstools/_devices/mixin_base.py +++ b/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. +# ----------------------------------------------------------------------------- diff --git a/apstools/_devices/motor_mixins.py b/apstools/_devices/motor_mixins.py index b7623ac77..67b0ed890 100644 --- a/apstools/_devices/motor_mixins.py +++ b/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. +# ----------------------------------------------------------------------------- diff --git a/apstools/_devices/positioner_soft_done.py b/apstools/_devices/positioner_soft_done.py index 8eeb33b78..790d75aef 100644 --- a/apstools/_devices/positioner_soft_done.py +++ b/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. +# ----------------------------------------------------------------------------- diff --git a/apstools/_devices/preamp_base.py b/apstools/_devices/preamp_base.py index 502ea1975..736e1570e 100644 --- a/apstools/_devices/preamp_base.py +++ b/apstools/_devices/preamp_base.py @@ -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. +# ----------------------------------------------------------------------------- diff --git a/apstools/_devices/ptc10_controller.py b/apstools/_devices/ptc10_controller.py index 35de0c918..1e4b1ed83 100644 --- a/apstools/_devices/ptc10_controller.py +++ b/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. +# ----------------------------------------------------------------------------- diff --git a/apstools/_devices/scaler_support.py b/apstools/_devices/scaler_support.py index f7f702f58..ff0da3886 100644 --- a/apstools/_devices/scaler_support.py +++ b/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. +# ----------------------------------------------------------------------------- diff --git a/apstools/_devices/shutters.py b/apstools/_devices/shutters.py index a495d34e7..623d180af 100644 --- a/apstools/_devices/shutters.py +++ b/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. +# ----------------------------------------------------------------------------- diff --git a/apstools/_devices/struck3820.py b/apstools/_devices/struck3820.py index fe37ba103..0accc06ce 100644 --- a/apstools/_devices/struck3820.py +++ b/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. +# ----------------------------------------------------------------------------- diff --git a/apstools/_devices/tracking_signal.py b/apstools/_devices/tracking_signal.py index adc298530..c6f3074c6 100644 --- a/apstools/_devices/tracking_signal.py +++ b/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. +# ----------------------------------------------------------------------------- diff --git a/apstools/_devices/xia_pf4.py b/apstools/_devices/xia_pf4.py index 912f2ce84..ec4a4fed9 100644 --- a/apstools/_devices/xia_pf4.py +++ b/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. +# ----------------------------------------------------------------------------- diff --git a/apstools/_plans/doc_run.py b/apstools/_plans/doc_run.py index 783fcb962..285dad407 100644 --- a/apstools/_plans/doc_run.py +++ b/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. +# ----------------------------------------------------------------------------- diff --git a/apstools/_utils/device_info.py b/apstools/_utils/device_info.py index 6092a4954..3586f3f71 100644 --- a/apstools/_utils/device_info.py +++ b/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. +# ----------------------------------------------------------------------------- diff --git a/apstools/_utils/list_plans.py b/apstools/_utils/list_plans.py index 9b439c9f5..bc38ca6a9 100644 --- a/apstools/_utils/list_plans.py +++ b/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. +# ----------------------------------------------------------------------------- diff --git a/apstools/_utils/override_parameters.py b/apstools/_utils/override_parameters.py index 43856dc44..0c0fe8e7e 100644 --- a/apstools/_utils/override_parameters.py +++ b/apstools/_utils/override_parameters.py @@ -137,3 +137,14 @@ def summary(self): parameters.append(parm) values.append(self.pick(parm, "--undefined--")) return pd.DataFrame(dict(parameter=parameters, value=values)) + + +# ----------------------------------------------------------------------------- +# :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. +# ----------------------------------------------------------------------------- diff --git a/setup.py b/setup.py index dc140b15f..da12d73cb 100755 --- a/setup.py +++ b/setup.py @@ -47,3 +47,14 @@ zip_safe=package.__zip_safe__, python_requires=package.__python_version_required__, ) + + +# ----------------------------------------------------------------------------- +# :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. +# ----------------------------------------------------------------------------- From b3b3f5e8d00b16282f2f62e935c2a65f2d63b5d8 Mon Sep 17 00:00:00 2001 From: Pete R Jemian Date: Fri, 26 Nov 2021 21:52:43 -0600 Subject: [PATCH 3/3] DOC #577 --- apstools/devices.py | 15 ++++++++++++ apstools/plans.py | 32 +++++++++++++++++++++++++ apstools/utils.py | 54 +++++++++++++++++++++++++++++++++++++++++++ docs/source/index.rst | 17 ++++++++++++++ 4 files changed, 118 insertions(+) diff --git a/apstools/devices.py b/apstools/devices.py index 9a02f968c..15077b3f8 100644 --- a/apstools/devices.py +++ b/apstools/devices.py @@ -1,6 +1,8 @@ """ (ophyd) Devices that might be useful at the APS using Bluesky +.. _devices.aps_support: + APS GENERAL SUPPORT .. autosummary:: @@ -12,6 +14,8 @@ ~apstools._devices.shutters.ApsPssShutterWithStatus ~apstools._devices.shutters.SimulatedApsPssShutterWithStatus +.. _devices.area_detector: + AREA DETECTOR SUPPORT .. autosummary:: @@ -22,6 +26,8 @@ ~apstools._devices.area_detector_support.AD_prime_plugin ~apstools._devices.area_detector_support.AD_setup_FrameType +.. _devices.scalers: + DETECTOR / SCALER SUPPORT .. autosummary:: @@ -29,6 +35,8 @@ ~apstools._devices.struck3820.Struck3820 ~apstools._devices.scaler_support.use_EPICS_scaler_channels +.. _devices.motors: + MOTORS, POSITIONERS, AXES, ... .. autosummary:: @@ -47,6 +55,9 @@ ~apstools._devices.shutters.EpicsMotorShutter ~apstools._devices.shutters.EpicsOnOffShutter +.. _devices.shutters: + + SHUTTERS .. autosummary:: @@ -59,10 +70,14 @@ ~apstools._devices.shutters.ShutterBase ~apstools._devices.shutters.SimulatedApsPssShutterWithStatus +.. _devices.synApps_support: + synApps Support See separate :ref:`synApps` section. +.. _devices.temperature_controllers: + TEMPERATURE CONTROLLERS .. autosummary:: diff --git a/apstools/plans.py b/apstools/plans.py index c79626e95..3949c98aa 100644 --- a/apstools/plans.py +++ b/apstools/plans.py @@ -1,6 +1,38 @@ """ Plans that might be useful at the APS when using Bluesky +.. _plans.batch + +BATCH SCANNING + +.. autosummary:: + + ~execute_command_list + ~get_command_list + ~parse_Excel_command_file + ~parse_text_command_file + ~register_command_handler + ~run_command_file + ~summarize_command_file + +.. _plans.custom + +CUSTOM SCANS + +.. autosummary:: + + ~apstools._plans.doc_run.documentation_run + ~lineup + ~nscan + ~snapshot + ~sscan_1D + ~TuneAxis + ~tune_axes + +.. _plans.overall + +OVERALL + .. autosummary:: ~apstools._plans.doc_run.addDeviceDataAsStream diff --git a/apstools/utils.py b/apstools/utils.py index c1adf0484..598bcf96e 100644 --- a/apstools/utils.py +++ b/apstools/utils.py @@ -1,8 +1,62 @@ """ Various utilities +.. _utils.finding + +FINDING + + ~findbyname + ~findbypv + ~findCatalogsInNamespace + +.. _utils.listing + +LISTING + +.. autosummary:: + + ~apstools._utils.device_info.listdevice + ~apstools._utils.device_info.listdevice_1_5_2 + ~listobjects + ~apstools._utils.list_plans.listplans + ~listRunKeys + ~ListRuns + ~listruns + ~listruns_v1_4 + +.. _utils.reporting + +REPORTING + +.. autosummary:: + + ~print_RE_md + ~print_snapshot_list + +.. _utils.other + +OTHER UTILITIES + +.. autosummary:: + + ~cleanupText + ~connect_pvlist + ~EmailNotifications + ~select_live_plot + ~select_mpl_figure + ~trim_plot_by_name + ~trim_plot_lines + ~trim_string_for_EPICS + ~unix + +.. _utils.general + +GENERAL + .. autosummary:: + ~cleanupText + ~cleanupText ~command_list_as_table ~connect_pvlist diff --git a/docs/source/index.rst b/docs/source/index.rst index 8cd9c602c..6c6c92a42 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -14,6 +14,23 @@ Summary Contents * :ref:`applications` * :ref:`examples` * :ref:`api_documentation` + * Devices + * :ref:`APS general support ` + * :ref:`area detector support ` + * :ref:`motors, positioners, ... ` + * :ref:`scalers ` + * :ref:`shutters ` + * :ref:`synApps support ` + * :ref:`temperature controllers ` + * Plans + * :ref:`batch scanning support ` + * :ref:`custom scans ` + * :func:`~apstools.plans.lineup()` + * Utilities + * :ref:`Finding ... ` + * :ref:`Listing ... ` + * :ref:`Reporting ... ` + * :ref:`Other ... ` * :ref:`license` Package Information