From a97cbc0439073f6c2c6b6e3bbfe684a32e9bf022 Mon Sep 17 00:00:00 2001 From: Zachary Lentz Date: Tue, 16 Apr 2024 11:43:02 -0700 Subject: [PATCH 1/5] DOC: run release notes scripts --- docs/source/releases.rst | 69 +++++++++++++++++++ .../upcoming_release_notes/1116-smarpod.rst | 30 -------- .../1184-Add_opcpa_LXT_motor.rst | 31 --------- ...ACR_status_option_for_CCM_energy_moves.rst | 34 --------- ...k4-att_RTD_PV_to_match_the_prefix_SPEC.rst | 30 -------- ...r_beckhoff_axis_with_custom_eps_screen.rst | 30 -------- .../upcoming_release_notes/1206-var-cool.rst | 30 -------- .../1208-add_temporary_li2k4_gui.rst | 30 -------- ...rigger_config_attributes,_add_TCMPL_PV.rst | 30 -------- ...d-status-signals-to-mpod-apalis-module.rst | 32 --------- .../1214-SmarAct_Updates.rst | 40 ----------- ...card,_chan_num_in_EnvironmentalMonitor.rst | 30 -------- ...Fixing_Tpr_Bug_For_MultiDerivedSignals.rst | 33 --------- 13 files changed, 69 insertions(+), 380 deletions(-) delete mode 100644 docs/source/upcoming_release_notes/1116-smarpod.rst delete mode 100644 docs/source/upcoming_release_notes/1184-Add_opcpa_LXT_motor.rst delete mode 100644 docs/source/upcoming_release_notes/1194-Add_ACR_status_option_for_CCM_energy_moves.rst delete mode 100644 docs/source/upcoming_release_notes/1201-modify_sp1k4-att_RTD_PV_to_match_the_prefix_SPEC.rst delete mode 100644 docs/source/upcoming_release_notes/1204-Add_embedded_gui_for_beckhoff_axis_with_custom_eps_screen.rst delete mode 100644 docs/source/upcoming_release_notes/1206-var-cool.rst delete mode 100644 docs/source/upcoming_release_notes/1208-add_temporary_li2k4_gui.rst delete mode 100644 docs/source/upcoming_release_notes/1210-Update_TprTrigger_config_attributes,_add_TCMPL_PV.rst delete mode 100644 docs/source/upcoming_release_notes/1211-add-status-signals-to-mpod-apalis-module.rst delete mode 100644 docs/source/upcoming_release_notes/1214-SmarAct_Updates.rst delete mode 100644 docs/source/upcoming_release_notes/1215-Add_card,_chan_num_in_EnvironmentalMonitor.rst delete mode 100644 docs/source/upcoming_release_notes/1216-Fixing_Tpr_Bug_For_MultiDerivedSignals.rst diff --git a/docs/source/releases.rst b/docs/source/releases.rst index e255de17be4..de420ef6d20 100644 --- a/docs/source/releases.rst +++ b/docs/source/releases.rst @@ -2,6 +2,75 @@ Release History ############### +v8.4.0 (2024-04-16) +=================== + +API Breaks +---------- +- If release < R1.0.20 then the EPICS signals will timeout on the new PVs. + Please make sure to update your children IOCs. + +Features +-------- +- add only x and Y axes gui for li2k4 for SC commission only +- Adds the following temperature monitoring PVs: + - channel_temp + - module_temp +- Adds the following hidden config PVs to encoded devices: + - log_scale_offset + - log_scale_inv + - def_range_min + - def_range_max +- Adds SmarActEncodedTipTilt device to epics_motor.py +- ioc_chan_num and ion_card_num were added to EnvironmentalMonitor in containers.py +- add missing epics signals to MPODApalisModule (supply_status, module_status, +- Adding the 'embedded' file allows for typhos screens to open using the compact controls. + +Device Updates +-------------- +- TprTrigger: Update numerous PVs to 'config', add TCMPL PV +- SmarActOpenLoop gets temp monitoring PVs +- SmarAct gets temp monitoring PVs +- Add a CCMEnergyWithACRStatus class to ccm.py +- Add a energy_with_acr_status instance to CCM +- Update BeamEnergyRequest argument from bunch to pv_index to better reflect the broader use cases. + A backward compatible warning is now returned if the old bunch kwarg is used. +- Update atol in BeamEnergyRequestNoWait to 0.5 (was 5). This is needed for self-seeding +- MPODApalisModule +- `XOffsetMirrorStateCool` and `XOffsetMirrorNoBend` gets `variable_cool` for controlling 24V solenoid valve. + +New Devices +----------- +- li2k4 +- Lcls2LaserTiming: New class supporting control of laser timing for the OPCPA + laser locker system. +- SmarActEncodedTipTilt +- Add a convenience decorator to re-arg a function in utils.py +- Add `SmarPod` and related devices in new `pcdsdevices.smarpod` module. + +Bugfixes +-------- +- Previously, calculate_on_get/put functions used in MultiDerivedSignals in tpr classes were not accessing + their attrs correctly and would throw KeyErrors when called +- Specifically, the name of the attr was being used as the key for items dictionary instead of the actual signal object +- Also added unit tests for these MultiDerivedSignals +- Modify SP1K4 Attenuator RTD class to match prefix for SP1K4 group device + +Contributors +------------ +- @tongju12 +- KaushikMalapati +- aberges +- baljamal +- jozamudi +- nrwslac +- patoppermann +- sainyamn, nagar123@slac.stanford.edu +- slactjohnson +- vespos + + + v8.3.0 (2024-02-21) =================== diff --git a/docs/source/upcoming_release_notes/1116-smarpod.rst b/docs/source/upcoming_release_notes/1116-smarpod.rst deleted file mode 100644 index d8585e391f4..00000000000 --- a/docs/source/upcoming_release_notes/1116-smarpod.rst +++ /dev/null @@ -1,30 +0,0 @@ -1116 smarpod -############ - -API Breaks ----------- -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- N/A - -New Devices ------------ -- Add `SmarPod` and related devices in new `pcdsdevices.smarpod` module. - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- patoppermann diff --git a/docs/source/upcoming_release_notes/1184-Add_opcpa_LXT_motor.rst b/docs/source/upcoming_release_notes/1184-Add_opcpa_LXT_motor.rst deleted file mode 100644 index 3f49ef66039..00000000000 --- a/docs/source/upcoming_release_notes/1184-Add_opcpa_LXT_motor.rst +++ /dev/null @@ -1,31 +0,0 @@ -1184 Add opcpa LXT motor -################# - -API Breaks ----------- -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- N/A - -New Devices ------------ -- Lcls2LaserTiming: New class supporting control of laser timing for the OPCPA - laser locker system. - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- slactjohnson diff --git a/docs/source/upcoming_release_notes/1194-Add_ACR_status_option_for_CCM_energy_moves.rst b/docs/source/upcoming_release_notes/1194-Add_ACR_status_option_for_CCM_energy_moves.rst deleted file mode 100644 index c44dac6fbbd..00000000000 --- a/docs/source/upcoming_release_notes/1194-Add_ACR_status_option_for_CCM_energy_moves.rst +++ /dev/null @@ -1,34 +0,0 @@ -1194 Add ACR status option for CCM energy moves -################# - -API Breaks ----------- -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- Add a CCMEnergyWithACRStatus class to ccm.py -- Add a energy_with_acr_status instance to CCM -- Update BeamEnergyRequest argument from bunch to pv_index to better reflect the broader use cases. - A backward compatible warning is now returned if the old bunch kwarg is used. -- Update atol in BeamEnergyRequestNoWait to 0.5 (was 5). This is needed for self-seeding - -New Devices ------------ -- Add a convenience decorator to re-arg a function in utils.py - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- vespos diff --git a/docs/source/upcoming_release_notes/1201-modify_sp1k4-att_RTD_PV_to_match_the_prefix_SPEC.rst b/docs/source/upcoming_release_notes/1201-modify_sp1k4-att_RTD_PV_to_match_the_prefix_SPEC.rst deleted file mode 100644 index 32954b01964..00000000000 --- a/docs/source/upcoming_release_notes/1201-modify_sp1k4-att_RTD_PV_to_match_the_prefix_SPEC.rst +++ /dev/null @@ -1,30 +0,0 @@ -1201 modify sp1k4-att RTD PV to match the prefix SPEC -################# - -API Breaks ----------- -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- N/A - -New Devices ------------ -- N/A - -Bugfixes --------- -- Modify SP1K4 Attenuator RTD class to match prefix for SP1K4 group device - -Maintenance ------------ -- N/A - -Contributors ------------- -- @tongju12 diff --git a/docs/source/upcoming_release_notes/1204-Add_embedded_gui_for_beckhoff_axis_with_custom_eps_screen.rst b/docs/source/upcoming_release_notes/1204-Add_embedded_gui_for_beckhoff_axis_with_custom_eps_screen.rst deleted file mode 100644 index b39a912be85..00000000000 --- a/docs/source/upcoming_release_notes/1204-Add_embedded_gui_for_beckhoff_axis_with_custom_eps_screen.rst +++ /dev/null @@ -1,30 +0,0 @@ -1204 Add embedded gui for beckhoff axis with custom eps screen -################# - -API Breaks ----------- -- N/A - -Features --------- -- Adding the 'embedded' file allows for typhos screens to open using the compact controls. - -Device Updates --------------- -- N/A - -New Devices ------------ -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- jozamudi diff --git a/docs/source/upcoming_release_notes/1206-var-cool.rst b/docs/source/upcoming_release_notes/1206-var-cool.rst deleted file mode 100644 index fc75e770a25..00000000000 --- a/docs/source/upcoming_release_notes/1206-var-cool.rst +++ /dev/null @@ -1,30 +0,0 @@ -1206 var-cool -################# - -API Breaks ----------- -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- `XOffsetMirrorStateCool` and `XOffsetMirrorNoBend` gets `variable_cool` for controlling 24V solenoid valve. - -New Devices ------------ -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- nrwslac diff --git a/docs/source/upcoming_release_notes/1208-add_temporary_li2k4_gui.rst b/docs/source/upcoming_release_notes/1208-add_temporary_li2k4_gui.rst deleted file mode 100644 index 7c446837c24..00000000000 --- a/docs/source/upcoming_release_notes/1208-add_temporary_li2k4_gui.rst +++ /dev/null @@ -1,30 +0,0 @@ -1208 add temporary li2k4 gui -################# - -API Breaks ----------- -- N/A - -Features --------- -- add only x and Y axes gui for li2k4 for SC commission only - -Device Updates --------------- -- N/A - -New Devices ------------ -- li2k4 - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- @tongju12 diff --git a/docs/source/upcoming_release_notes/1210-Update_TprTrigger_config_attributes,_add_TCMPL_PV.rst b/docs/source/upcoming_release_notes/1210-Update_TprTrigger_config_attributes,_add_TCMPL_PV.rst deleted file mode 100644 index 42c9b70d490..00000000000 --- a/docs/source/upcoming_release_notes/1210-Update_TprTrigger_config_attributes,_add_TCMPL_PV.rst +++ /dev/null @@ -1,30 +0,0 @@ -1210 Update TprTrigger config attributes, add TCMPL PV -################# - -API Breaks ----------- -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- TprTrigger: Update numerous PVs to 'config', add TCMPL PV - -New Devices ------------ -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- slactjohnson diff --git a/docs/source/upcoming_release_notes/1211-add-status-signals-to-mpod-apalis-module.rst b/docs/source/upcoming_release_notes/1211-add-status-signals-to-mpod-apalis-module.rst deleted file mode 100644 index d7cc5458252..00000000000 --- a/docs/source/upcoming_release_notes/1211-add-status-signals-to-mpod-apalis-module.rst +++ /dev/null @@ -1,32 +0,0 @@ -1211 add status signals to mpod apalis module -################# - -API Breaks ----------- -- N/A - -Features --------- -- add missing epics signals to MPODApalisModule (supply_status, module_status, -fine_adjustment_status, input_status, live_insertion_status,saftey_loop_status, -kill) - -Device Updates --------------- -- MPODApalisModule - -New Devices ------------ -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- baljamal diff --git a/docs/source/upcoming_release_notes/1214-SmarAct_Updates.rst b/docs/source/upcoming_release_notes/1214-SmarAct_Updates.rst deleted file mode 100644 index a9162406818..00000000000 --- a/docs/source/upcoming_release_notes/1214-SmarAct_Updates.rst +++ /dev/null @@ -1,40 +0,0 @@ -1214 SmarAct Updates -################# - -API Breaks ----------- -- If release < R1.0.20 then the EPICS signals will timeout on the new PVs. - Please make sure to update your children IOCs. - -Features --------- -- Adds the following temperature monitoring PVs: - - channel_temp - - module_temp -- Adds the following hidden config PVs to encoded devices: - - log_scale_offset - - log_scale_inv - - def_range_min - - def_range_max -- Adds SmarActEncodedTipTilt device to epics_motor.py - -Device Updates --------------- -- SmarActOpenLoop gets temp monitoring PVs -- SmarAct gets temp monitoring PVs - -New Devices ------------ -- SmarActEncodedTipTilt - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- aberges diff --git a/docs/source/upcoming_release_notes/1215-Add_card,_chan_num_in_EnvironmentalMonitor.rst b/docs/source/upcoming_release_notes/1215-Add_card,_chan_num_in_EnvironmentalMonitor.rst deleted file mode 100644 index 2cf1bae2d32..00000000000 --- a/docs/source/upcoming_release_notes/1215-Add_card,_chan_num_in_EnvironmentalMonitor.rst +++ /dev/null @@ -1,30 +0,0 @@ -1215 Add card, chan num in EnvironmentalMonitor -################# - -API Breaks ----------- -- N/A - -Features --------- -- ioc_chan_num and ion_card_num were added to EnvironmentalMonitor in containers.py - -Device Updates --------------- -- N/A - -New Devices ------------ -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- sainyamn, nagar123@slac.stanford.edu diff --git a/docs/source/upcoming_release_notes/1216-Fixing_Tpr_Bug_For_MultiDerivedSignals.rst b/docs/source/upcoming_release_notes/1216-Fixing_Tpr_Bug_For_MultiDerivedSignals.rst deleted file mode 100644 index 10137bf0744..00000000000 --- a/docs/source/upcoming_release_notes/1216-Fixing_Tpr_Bug_For_MultiDerivedSignals.rst +++ /dev/null @@ -1,33 +0,0 @@ -1216 Fixing_Tpr_Bug_For_MultiDerivedSignals -################# - -API Breaks ----------- -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- N/A - -New Devices ------------ -- N/A - -Bugfixes --------- -- Previously, calculate_on_get/put functions used in MultiDerivedSignals in tpr classes were not accessing - their attrs correctly and would throw KeyErrors when called -- Specifically, the name of the attr was being used as the key for items dictionary instead of the actual signal object -- Also added unit tests for these MultiDerivedSignals - -Maintenance ------------ -- N/A - -Contributors ------------- -- KaushikMalapati From 4e5c8ec4e3359b0d4bddb7d122f531f4fa170267 Mon Sep 17 00:00:00 2001 From: Zachary Lentz Date: Tue, 16 Apr 2024 19:13:13 +0000 Subject: [PATCH 2/5] DOC: proofread and standardize style for release notes --- docs/source/releases.rst | 85 +++++++++++++++++++++------------------- 1 file changed, 44 insertions(+), 41 deletions(-) diff --git a/docs/source/releases.rst b/docs/source/releases.rst index de420ef6d20..60c330f0ad1 100644 --- a/docs/source/releases.rst +++ b/docs/source/releases.rst @@ -1,76 +1,79 @@ Release History ############### - v8.4.0 (2024-04-16) =================== -API Breaks ----------- -- If release < R1.0.20 then the EPICS signals will timeout on the new PVs. +Compatibility Notes +------------------- +- If your SmarAct release is < R1.0.20, then the EPICS signals will timeout on the new PVs. Please make sure to update your children IOCs. Features -------- -- add only x and Y axes gui for li2k4 for SC commission only -- Adds the following temperature monitoring PVs: - - channel_temp - - module_temp -- Adds the following hidden config PVs to encoded devices: - - log_scale_offset - - log_scale_inv - - def_range_min - - def_range_max -- Adds SmarActEncodedTipTilt device to epics_motor.py -- ioc_chan_num and ion_card_num were added to EnvironmentalMonitor in containers.py -- add missing epics signals to MPODApalisModule (supply_status, module_status, -- Adding the 'embedded' file allows for typhos screens to open using the compact controls. +- Adds `ioc_chan_num` and `ioc_card_num` to the `EnvironmentalMonitor` happi container. +- Adds the "embedded" file for `BeckhoffAxisEPSCustom` that allows for typhos screens to open using the compact controls. +- Adds a convenience `re_arg` decorator to redefine and deprecate a function's args in a backwards-compatible way in the `utils` submodule. Device Updates -------------- -- TprTrigger: Update numerous PVs to 'config', add TCMPL PV -- SmarActOpenLoop gets temp monitoring PVs -- SmarAct gets temp monitoring PVs -- Add a CCMEnergyWithACRStatus class to ccm.py -- Add a energy_with_acr_status instance to CCM -- Update BeamEnergyRequest argument from bunch to pv_index to better reflect the broader use cases. +- `TprTrigger`: Update numerous PVs to "config", add TCMPL PV as the `operation` signal. +- Adds the following temperature monitoring signals to `Smaract` and `SmarActOpenLoop`: + + - `channel_temp` + - `module_temp` +- Adds the following hidden config PVs to the (encoded) `SmarAct` device class: + + - `log_scale_offset` + - `log_scale_inv` + - `def_range_min` + - `def_range_max` + - `dist_code_inv` +- Adds the following missing epics signals to `MPODApalisModule`: + + - `supply_status` + - `module_status` + - `fine_adjustment_status` + - `input_status` + - `live_insertion_status` + - `safety_loop_status` + - `kill` + +- Adds a `energy_with_acr_status` instance to CCM +- Updates `BeamEnergyRequest` argument from "bunch" to "pv_index" to better reflect the broader use cases. A backward compatible warning is now returned if the old bunch kwarg is used. -- Update atol in BeamEnergyRequestNoWait to 0.5 (was 5). This is needed for self-seeding -- MPODApalisModule +- Updates "atol" in `BeamEnergyRequestNoWait` to 0.5 (was 5). This is needed for self-seeding. - `XOffsetMirrorStateCool` and `XOffsetMirrorNoBend` gets `variable_cool` for controlling 24V solenoid valve. New Devices ----------- -- li2k4 -- Lcls2LaserTiming: New class supporting control of laser timing for the OPCPA - laser locker system. -- SmarActEncodedTipTilt -- Add a convenience decorator to re-arg a function in utils.py -- Add `SmarPod` and related devices in new `pcdsdevices.smarpod` module. +- Adds li2k4, with the x and y motors supported (no states yet). +- Adds `Lcls2LaserTiming`: New class supporting control of laser timing for the OPCPA laser locker system. +- Adds `SmarActEncodedTipTilt` to the `epics_motor` submodule. +- Adds `SmarPod` and related devices in new `smarpod` submodule. +- Adds a `CCMEnergyWithACRStatus` class to the `ccm` submodule, a new variant of `CCMEnergy` that waits for ACR status before marking moves as complete. Bugfixes -------- -- Previously, calculate_on_get/put functions used in MultiDerivedSignals in tpr classes were not accessing - their attrs correctly and would throw KeyErrors when called -- Specifically, the name of the attr was being used as the key for items dictionary instead of the actual signal object -- Also added unit tests for these MultiDerivedSignals -- Modify SP1K4 Attenuator RTD class to match prefix for SP1K4 group device +- Previously, calculate_on_get/put functions used in `MultiDerivedSignals` in `tpr` classes were not accessing their attrs correctly and would throw KeyErrors when called. + Specifically, the name of the attr was being used as the key for items dictionary instead of the actual signal object +- Also added unit tests for these `MultiDerivedSignals` in the `tpr` module. +- Modify `SP1K4` Attenuator RTD class to match prefix for SP1K4 group device. Contributors ------------ -- @tongju12 -- KaushikMalapati -- aberges +- aberges-SLAC - baljamal - jozamudi +- KaushikMalapati - nrwslac - patoppermann -- sainyamn, nagar123@slac.stanford.edu +- sainyamn - slactjohnson +- tongju12 - vespos - v8.3.0 (2024-02-21) =================== From 30ae7b2cbe144d32c0f3713b221a77d458c1c710 Mon Sep 17 00:00:00 2001 From: Zachary Lentz Date: Tue, 16 Apr 2024 20:22:39 +0000 Subject: [PATCH 3/5] DOC: more small fixes/tweaks e.g. dead links --- docs/source/releases.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/source/releases.rst b/docs/source/releases.rst index 60c330f0ad1..85682a59af9 100644 --- a/docs/source/releases.rst +++ b/docs/source/releases.rst @@ -13,12 +13,12 @@ Features -------- - Adds `ioc_chan_num` and `ioc_card_num` to the `EnvironmentalMonitor` happi container. - Adds the "embedded" file for `BeckhoffAxisEPSCustom` that allows for typhos screens to open using the compact controls. -- Adds a convenience `re_arg` decorator to redefine and deprecate a function's args in a backwards-compatible way in the `utils` submodule. +- Adds a convenience `re_arg` decorator to redefine and deprecate a function's args in a backwards-compatible way in the `pcdsdevices.utils` submodule. Device Updates -------------- - `TprTrigger`: Update numerous PVs to "config", add TCMPL PV as the `operation` signal. -- Adds the following temperature monitoring signals to `Smaract` and `SmarActOpenLoop`: +- Adds the following temperature monitoring signals to `SmarAct` and `SmarActOpenLoop`: - `channel_temp` - `module_temp` @@ -39,7 +39,7 @@ Device Updates - `safety_loop_status` - `kill` -- Adds a `energy_with_acr_status` instance to CCM +- Adds an `energy_with_acr_status` instance to CCM - Updates `BeamEnergyRequest` argument from "bunch" to "pv_index" to better reflect the broader use cases. A backward compatible warning is now returned if the old bunch kwarg is used. - Updates "atol" in `BeamEnergyRequestNoWait` to 0.5 (was 5). This is needed for self-seeding. @@ -47,18 +47,18 @@ Device Updates New Devices ----------- -- Adds li2k4, with the x and y motors supported (no states yet). +- Adds `li2k4` as `TMOLaserInCouplingTwoDimension`, with the x and y motors supported (no states yet). - Adds `Lcls2LaserTiming`: New class supporting control of laser timing for the OPCPA laser locker system. -- Adds `SmarActEncodedTipTilt` to the `epics_motor` submodule. -- Adds `SmarPod` and related devices in new `smarpod` submodule. -- Adds a `CCMEnergyWithACRStatus` class to the `ccm` submodule, a new variant of `CCMEnergy` that waits for ACR status before marking moves as complete. +- Adds `SmarActEncodedTipTilt` to the `pcdsdevices.epics_motor` submodule. +- Adds `SmarPod` and related devices in new `pcdsdevices.smarpod` submodule. +- Adds a `CCMEnergyWithACRStatus` class to the `pcdsdevices.ccm` submodule, a new variant of `CCMEnergy` that waits for ACR status before marking moves as complete. Bugfixes -------- -- Previously, calculate_on_get/put functions used in `MultiDerivedSignals` in `tpr` classes were not accessing their attrs correctly and would throw KeyErrors when called. +- Previously, calculate_on_get/put functions used in `MultiDerivedSignal`s in `pcdsdevices.tpr` classes were not accessing their attrs correctly and would throw KeyErrors when called. Specifically, the name of the attr was being used as the key for items dictionary instead of the actual signal object -- Also added unit tests for these `MultiDerivedSignals` in the `tpr` module. -- Modify `SP1K4` Attenuator RTD class to match prefix for SP1K4 group device. +- Also added unit tests for these `MultiDerivedSignal`s in the `pcdsdevices.tpr` submodule. +- Modify `sp1k4` Attenuator RTD class (`TMOSpectrometer`) to match prefix for `sp1k4` group device. Contributors ------------ From cb417d6a48c5e774c4f3240d698f62097f58fe37 Mon Sep 17 00:00:00 2001 From: Zachary Lentz Date: Tue, 16 Apr 2024 20:23:51 +0000 Subject: [PATCH 4/5] DOC: rebuild api list --- docs/source/api.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/source/api.rst b/docs/source/api.rst index 6a9e0453d03..3571431e953 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -140,6 +140,7 @@ pcdsdevices.ccm pcdsdevices.ccm.CCMAlio pcdsdevices.ccm.CCMConstantsMixin pcdsdevices.ccm.CCMEnergy + pcdsdevices.ccm.CCMEnergyWithACRStatus pcdsdevices.ccm.CCMEnergyWithVernier pcdsdevices.ccm.CCMMotor pcdsdevices.ccm.CCMPico @@ -274,6 +275,7 @@ pcdsdevices.epics_motor pcdsdevices.epics_motor.PCDSMotorBase pcdsdevices.epics_motor.PMC100 pcdsdevices.epics_motor.SmarAct + pcdsdevices.epics_motor.SmarActEncodedTipTilt pcdsdevices.epics_motor.SmarActOpenLoop pcdsdevices.epics_motor.SmarActOpenLoopPositioner pcdsdevices.epics_motor.SmarActTipTilt @@ -591,6 +593,14 @@ pcdsdevices.lic pcdsdevices.lic.LICMirror pcdsdevices.lic.LaserInCoupling +pcdsdevices.lic_2d_tmo +---------------------- + +.. autosummary:: + :toctree: generated + + pcdsdevices.lic_2d_tmo.TMOLaserInCouplingTwoDimension + pcdsdevices.light_control ------------------------- @@ -641,6 +651,7 @@ pcdsdevices.lxe pcdsdevices.lxe.LaserEnergyPositioner pcdsdevices.lxe.LaserTiming pcdsdevices.lxe.LaserTimingCompensation + pcdsdevices.lxe.Lcls2LaserTiming pcdsdevices.lxe.LxtTtcExample pcdsdevices.lxe.TimeToolDelay pcdsdevices.lxe._ReversedTimeToolDelay @@ -1030,6 +1041,16 @@ pcdsdevices.slits pcdsdevices.slits.Slits pcdsdevices.slits.SlitsBase +pcdsdevices.smarpod +------------------- + +.. autosummary:: + :toctree: generated + + pcdsdevices.smarpod.SmarPod + pcdsdevices.smarpod.SmarPodPose + pcdsdevices.smarpod.SmarPodStatus + pcdsdevices.spectrometer ------------------------ @@ -1165,6 +1186,7 @@ pcdsdevices.utils pcdsdevices.utils.maybe_make_method pcdsdevices.utils.move_subdevices_to_start pcdsdevices.utils.post_ophyds_to_elog + pcdsdevices.utils.re_arg pcdsdevices.utils.reorder_components pcdsdevices.utils.schedule_task pcdsdevices.utils.set_many From 8f0044dd2720dd31b5aeac013d01ef6db2766f80 Mon Sep 17 00:00:00 2001 From: Zachary Lentz Date: Tue, 16 Apr 2024 20:55:46 +0000 Subject: [PATCH 5/5] DOC: try again to fix broken links/rendering --- docs/source/releases.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/releases.rst b/docs/source/releases.rst index 85682a59af9..411506a8c28 100644 --- a/docs/source/releases.rst +++ b/docs/source/releases.rst @@ -55,9 +55,9 @@ New Devices Bugfixes -------- -- Previously, calculate_on_get/put functions used in `MultiDerivedSignal`s in `pcdsdevices.tpr` classes were not accessing their attrs correctly and would throw KeyErrors when called. +- Previously, calculate_on_get/put functions used in `MultiDerivedSignal` s in `pcdsdevices.tpr` classes were not accessing their attrs correctly and would throw KeyErrors when called. Specifically, the name of the attr was being used as the key for items dictionary instead of the actual signal object -- Also added unit tests for these `MultiDerivedSignal`s in the `pcdsdevices.tpr` submodule. +- Also added unit tests for these `MultiDerivedSignal` s in the `pcdsdevices.tpr` submodule. - Modify `sp1k4` Attenuator RTD class (`TMOSpectrometer`) to match prefix for `sp1k4` group device. Contributors