From 0ad0a6875e3fe5da2b2a64520d001bdb209c8f81 Mon Sep 17 00:00:00 2001 From: Zachary Lentz Date: Wed, 21 Feb 2024 14:12:45 -0800 Subject: [PATCH 1/3] REL: run release notes and api update scripts --- docs/source/api.rst | 99 +++++++++++++++++++ docs/source/releases.rst | 42 ++++++++ ...custom_screen_to_show_EPS_information..rst | 32 ------ .../1196-bug_at2l0_clear_error.rst | 31 ------ .../1198-Modifying_Exit_Slits.rst | 30 ------ .../1199-cool-updates.rst | 36 ------- 6 files changed, 141 insertions(+), 129 deletions(-) delete mode 100644 docs/source/upcoming_release_notes/1195-Added_BeckhofAxisEPSCustom_class_in_epics_motor.py_and_BeckhofAxisEpicsCusom.ui_to_allow_the_use_of_a_custom_screen_to_show_EPS_information..rst delete mode 100644 docs/source/upcoming_release_notes/1196-bug_at2l0_clear_error.rst delete mode 100644 docs/source/upcoming_release_notes/1198-Modifying_Exit_Slits.rst delete mode 100644 docs/source/upcoming_release_notes/1199-cool-updates.rst diff --git a/docs/source/api.rst b/docs/source/api.rst index 4cbe24f2150..6a9e0453d03 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -8,6 +8,7 @@ pcdsdevices.analog_signals :toctree: generated pcdsdevices.analog_signals.Acromag + pcdsdevices.analog_signals.FDQ pcdsdevices.analog_signals.Mesh pcdsdevices.analog_signals.acromag_ch_factory_func @@ -70,6 +71,7 @@ pcdsdevices.atm pcdsdevices.atm.ATMTarget pcdsdevices.atm.ArrivalTimeMonitor + pcdsdevices.atm.MFXATM pcdsdevices.atm.TM1K4 pcdsdevices.atm.TM1K4Target pcdsdevices.atm.TM2K2 @@ -107,6 +109,7 @@ pcdsdevices.attenuator pcdsdevices.attenuator.GasAttenuator pcdsdevices.attenuator.GattApertureX pcdsdevices.attenuator.GattApertureY + pcdsdevices.attenuator.SXRGasAtt pcdsdevices.attenuator.SXRLadderAttenuatorBlade pcdsdevices.attenuator.SXRLadderAttenuatorStates pcdsdevices.attenuator.get_blade_enum @@ -199,6 +202,14 @@ pcdsdevices.device pcdsdevices.device.InterfaceDevice pcdsdevices.device.to_interface +pcdsdevices.digital_signals +--------------------------- + +.. autosummary:: + :toctree: generated + + pcdsdevices.digital_signals.J120K + pcdsdevices.digitizers ---------------------- @@ -236,6 +247,7 @@ pcdsdevices.energy_monitor pcdsdevices.energy_monitor.GEM pcdsdevices.energy_monitor.GMD + pcdsdevices.energy_monitor.GMDPreAmp pcdsdevices.energy_monitor.XGMD pcdsdevices.epics_motor @@ -245,8 +257,11 @@ pcdsdevices.epics_motor :toctree: generated pcdsdevices.epics_motor.BeckhoffAxis + pcdsdevices.epics_motor.BeckhoffAxisEPS + pcdsdevices.epics_motor.BeckhoffAxisEPSCustom pcdsdevices.epics_motor.BeckhoffAxisNoOffset pcdsdevices.epics_motor.BeckhoffAxisPLC + pcdsdevices.epics_motor.BeckhoffAxisPLCEPS pcdsdevices.epics_motor.BeckhoffAxisPLC_Pre140 pcdsdevices.epics_motor.BeckhoffAxis_Pre140 pcdsdevices.epics_motor.EpicsMotorInterface @@ -263,6 +278,14 @@ pcdsdevices.epics_motor pcdsdevices.epics_motor.SmarActOpenLoopPositioner pcdsdevices.epics_motor.SmarActTipTilt +pcdsdevices.eps +--------------- + +.. autosummary:: + :toctree: generated + + pcdsdevices.eps.EPS + pcdsdevices.evr --------------- @@ -272,6 +295,19 @@ pcdsdevices.evr pcdsdevices.evr.EvrMotor pcdsdevices.evr.Trigger +pcdsdevices.example +------------------- + +.. autosummary:: + :toctree: generated + + pcdsdevices.example.Example3D + pcdsdevices.example.Example3DStates + pcdsdevices.example.ExampleL2L + pcdsdevices.example.ExampleL2LStates + pcdsdevices.example.PLCExampleMotion + pcdsdevices.example.PLCOnlyXPIM + pcdsdevices.fms --------------- @@ -411,6 +447,16 @@ pcdsdevices.jet pcdsdevices.jet.Injector pcdsdevices.jet.InjectorWithFine +pcdsdevices.keithley +-------------------- + +.. autosummary:: + :toctree: generated + + pcdsdevices.keithley.IM3L0_K2700 + pcdsdevices.keithley.K2700 + pcdsdevices.keithley.K6514 + pcdsdevices.lamp_motion ----------------------- @@ -571,6 +617,7 @@ pcdsdevices.lodcm pcdsdevices.lodcm.H2N pcdsdevices.lodcm.LODCM pcdsdevices.lodcm.LODCMEnergyC + pcdsdevices.lodcm.LODCMEnergyC1 pcdsdevices.lodcm.LODCMEnergySi pcdsdevices.lodcm.SimDiagnosticsTower pcdsdevices.lodcm.SimEnergyC @@ -628,6 +675,7 @@ pcdsdevices.mirror pcdsdevices.mirror.FFMirrorZ pcdsdevices.mirror.Gantry pcdsdevices.mirror.KBOMirror + pcdsdevices.mirror.KBOMirrorChin pcdsdevices.mirror.KBOMirrorHE pcdsdevices.mirror.KBOMirrorHEStates pcdsdevices.mirror.KBOMirrorStates @@ -640,6 +688,7 @@ pcdsdevices.mirror pcdsdevices.mirror.TwinCATMirrorStripe pcdsdevices.mirror.XOffsetMirror pcdsdevices.mirror.XOffsetMirrorBend + pcdsdevices.mirror.XOffsetMirrorNoBend pcdsdevices.mirror.XOffsetMirrorRTDs pcdsdevices.mirror.XOffsetMirrorState pcdsdevices.mirror.XOffsetMirrorStateCool @@ -701,6 +750,14 @@ pcdsdevices.mrco_motion pcdsdevices.mrco_motion.MRCO +pcdsdevices.pc +-------------- + +.. autosummary:: + :toctree: generated + + pcdsdevices.pc.PhotonCollimator + pcdsdevices.piezo ----------------- @@ -718,6 +775,7 @@ pcdsdevices.pim :toctree: generated pcdsdevices.pim.IM2K0 + pcdsdevices.pim.IM3L0 pcdsdevices.pim.LCLS2ImagerBase pcdsdevices.pim.LCLS2Target pcdsdevices.pim.PIM @@ -726,6 +784,8 @@ pcdsdevices.pim pcdsdevices.pim.PIMWithLED pcdsdevices.pim.PIMY pcdsdevices.pim.PPM + pcdsdevices.pim.PPMCOOL + pcdsdevices.pim.PPMCoolSwitch pcdsdevices.pim.PPMPowerMeter pcdsdevices.pim.XPIM pcdsdevices.pim.XPIMFilterWheel @@ -813,6 +873,21 @@ pcdsdevices.pv_positioner pcdsdevices.pv_positioner.PVPositionerComparator pcdsdevices.pv_positioner.PVPositionerDone pcdsdevices.pv_positioner.PVPositionerIsClose + pcdsdevices.pv_positioner.PVPositionerNoInterrupt + +pcdsdevices.qadc +---------------- + +.. autosummary:: + :toctree: generated + + pcdsdevices.qadc.Qadc + pcdsdevices.qadc.Qadc134 + pcdsdevices.qadc.Qadc134Common + pcdsdevices.qadc.Qadc134Lcls2 + pcdsdevices.qadc.QadcCommon + pcdsdevices.qadc.QadcLcls1Timing + pcdsdevices.qadc.QadcLcls2Timing pcdsdevices.radiation --------------------- @@ -961,17 +1036,28 @@ pcdsdevices.spectrometer .. autosummary:: :toctree: generated + pcdsdevices.spectrometer.FZPStates pcdsdevices.spectrometer.Gen1VonHamos4Crystal pcdsdevices.spectrometer.Gen1VonHamosCrystal pcdsdevices.spectrometer.HXRSpectrometer pcdsdevices.spectrometer.Kmono pcdsdevices.spectrometer.Mono pcdsdevices.spectrometer.TMOSpectrometer + pcdsdevices.spectrometer.TMOSpectrometerSOLIDATTStates pcdsdevices.spectrometer.VonHamos4Crystal pcdsdevices.spectrometer.VonHamosCrystal pcdsdevices.spectrometer.VonHamosFE pcdsdevices.spectrometer.VonHamosFER +pcdsdevices.sqr1 +---------------- + +.. autosummary:: + :toctree: generated + + pcdsdevices.sqr1.SQR1 + pcdsdevices.sqr1.SQR1Axis + pcdsdevices.state ----------------- @@ -988,6 +1074,7 @@ pcdsdevices.state pcdsdevices.state.TwinCATStateConfigOne pcdsdevices.state.TwinCATStatePositioner pcdsdevices.state.get_dynamic_state_attr + pcdsdevices.state.state_config_dotted_attribute pcdsdevices.state.state_config_dotted_names pcdsdevices.state.state_config_dotted_velos @@ -1008,6 +1095,7 @@ pcdsdevices.sxr_test_absorber :toctree: generated pcdsdevices.sxr_test_absorber.SxrTestAbsorber + pcdsdevices.sxr_test_absorber.SxrTestAbsorberStates pcdsdevices.tags ---------------- @@ -1039,6 +1127,15 @@ pcdsdevices.timetool pcdsdevices.timetool.Timetool pcdsdevices.timetool.TimetoolWithNav +pcdsdevices.tpr +--------------- + +.. autosummary:: + :toctree: generated + + pcdsdevices.tpr.TprMotor + pcdsdevices.tpr.TprTrigger + pcdsdevices.usb_encoder ----------------------- @@ -1116,3 +1213,5 @@ pcdsdevices.wfs pcdsdevices.wfs.WaveFrontSensorStates pcdsdevices.wfs.WaveFrontSensorTarget + pcdsdevices.wfs.WaveFrontSensorTargetCool + pcdsdevices.wfs.WaveFrontSensorTargetFDQ diff --git a/docs/source/releases.rst b/docs/source/releases.rst index 74a50225dc5..8b5e20dfbb4 100644 --- a/docs/source/releases.rst +++ b/docs/source/releases.rst @@ -2,6 +2,48 @@ Release History ############### +v8.3.0 (2024-02-21) +=================== + +Features +-------- +- Added BeckhofAxisEPSCustom class in epics_motor.py and + BeckhofAxisEpicsCusom.ui to allow the use of a custom screen to show EPS + information. + +Device Updates +-------------- +- in `atm.py` add `flow_meter` to `ArrivalTimeMonitor` +- in `attenuator.py` add `flow_meter` to `AttenuatorSXR_Ladder` +- in `attenuator.py` add `flow_meter` to `AttenuatorSXR_LadderTwoBladeLBD` +- in `device_types.py` add `WaveFrontSensorTargetCool` , `WaveFrontSensorTargetFDQ` +- in `mirror.py` add flow sensor variable to `FFMirror` +- Piezo pitch motors for the `ExitSlits` crystals were added + +New Devices +----------- +- add class `PhotonCollimator` to readout `flow_switch` in new module `pc.py` +- add class `WaveFrontSensorTargetFDQ` to read out `flow_meter` +- add class `MFXATM` in `atm.py` + +Bugfixes +-------- +- Fix an issue where at2l0.clear_errors would not run properly. + +Maintenance +----------- +- Add missing regression tests for at2l0. +- Update versions of pre-commit checks to latest and fix new flake8 errors. + +Contributors +------------ +- ghalym +- jozamudi +- nrwslac +- zllentz + + + v8.2.0 (2023-12-19) =================== diff --git a/docs/source/upcoming_release_notes/1195-Added_BeckhofAxisEPSCustom_class_in_epics_motor.py_and_BeckhofAxisEpicsCusom.ui_to_allow_the_use_of_a_custom_screen_to_show_EPS_information..rst b/docs/source/upcoming_release_notes/1195-Added_BeckhofAxisEPSCustom_class_in_epics_motor.py_and_BeckhofAxisEpicsCusom.ui_to_allow_the_use_of_a_custom_screen_to_show_EPS_information..rst deleted file mode 100644 index 6f68e67b5da..00000000000 --- a/docs/source/upcoming_release_notes/1195-Added_BeckhofAxisEPSCustom_class_in_epics_motor.py_and_BeckhofAxisEpicsCusom.ui_to_allow_the_use_of_a_custom_screen_to_show_EPS_information..rst +++ /dev/null @@ -1,32 +0,0 @@ -1195 Add the ability to use a Custom screen in BeckhoffAxis typhos screen for EPS -################# - -API Breaks ----------- -- N/A - -Features --------- -- Added BeckhofAxisEPSCustom class in epics_motor.py and - BeckhofAxisEpicsCusom.ui to allow the use of a custom screen to show EPS - information. - -Device Updates --------------- -- N/A - -New Devices ------------ -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- jozamudi diff --git a/docs/source/upcoming_release_notes/1196-bug_at2l0_clear_error.rst b/docs/source/upcoming_release_notes/1196-bug_at2l0_clear_error.rst deleted file mode 100644 index c3f7cf1c330..00000000000 --- a/docs/source/upcoming_release_notes/1196-bug_at2l0_clear_error.rst +++ /dev/null @@ -1,31 +0,0 @@ -1196 bug_at2l0_clear_error -################# - -API Breaks ----------- -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- N/A - -New Devices ------------ -- N/A - -Bugfixes --------- -- Fix an issue where at2l0.clear_errors would not run properly. - -Maintenance ------------ -- Add missing regression tests for at2l0. -- Update versions of pre-commit checks to latest and fix new flake8 errors. - -Contributors ------------- -- zllentz diff --git a/docs/source/upcoming_release_notes/1198-Modifying_Exit_Slits.rst b/docs/source/upcoming_release_notes/1198-Modifying_Exit_Slits.rst deleted file mode 100644 index 85bdeb687e7..00000000000 --- a/docs/source/upcoming_release_notes/1198-Modifying_Exit_Slits.rst +++ /dev/null @@ -1,30 +0,0 @@ -1198 Modifying Exit Slits -################# - -API Breaks ----------- -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- Piezo pitch motors for the `ExitSlits` crystals were added - -New Devices ------------ -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- ghalym diff --git a/docs/source/upcoming_release_notes/1199-cool-updates.rst b/docs/source/upcoming_release_notes/1199-cool-updates.rst deleted file mode 100644 index 36f07e9d2f2..00000000000 --- a/docs/source/upcoming_release_notes/1199-cool-updates.rst +++ /dev/null @@ -1,36 +0,0 @@ -1199 cool-updates -################# - -API Breaks ----------- -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- in `atm.py` add `flow_meter` to `ArrivalTimeMonitor` -- in `attenuator.py` add `flow_meter` to `AttenuatorSXR_Ladder` -- in `attenuator.py` add `flow_meter` to `AttenuatorSXR_LadderTwoBladeLBD` -- in `device_types.py` add `WaveFrontSensorTargetCool` , `WaveFrontSensorTargetFDQ` -- in `mirror.py` add flow sensor variable to `FFMirror` - -New Devices ------------ -- add class `PhotonCollimator` to readout `flow_switch` in new module `pc.py` -- add class `WaveFrontSensorTargetFDQ` to read out `flow_meter` -- add class `MFXATM` in `atm.py` - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- nrwslac From 020bd743c1f10f2df4a8ea001b24e31c2a33f890 Mon Sep 17 00:00:00 2001 From: Zachary Lentz Date: Wed, 21 Feb 2024 14:33:06 -0800 Subject: [PATCH 2/3] DOC: proofread/unify docs and try to get sphinx links to work --- docs/source/releases.rst | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/docs/source/releases.rst b/docs/source/releases.rst index 8b5e20dfbb4..98679de76ce 100644 --- a/docs/source/releases.rst +++ b/docs/source/releases.rst @@ -7,33 +7,33 @@ v8.3.0 (2024-02-21) Features -------- -- Added BeckhofAxisEPSCustom class in epics_motor.py and - BeckhofAxisEpicsCusom.ui to allow the use of a custom screen to show EPS - information. +- Enabled the use of custom EPS screens for Beckhoff axes via the + `BeckhoffAxisEPSCustom` class in `pcdsdevices.epics_motor` and + the accompanying ui template file. Device Updates -------------- -- in `atm.py` add `flow_meter` to `ArrivalTimeMonitor` -- in `attenuator.py` add `flow_meter` to `AttenuatorSXR_Ladder` -- in `attenuator.py` add `flow_meter` to `AttenuatorSXR_LadderTwoBladeLBD` -- in `device_types.py` add `WaveFrontSensorTargetCool` , `WaveFrontSensorTargetFDQ` -- in `mirror.py` add flow sensor variable to `FFMirror` -- Piezo pitch motors for the `ExitSlits` crystals were added +- Added `flow_meter` to `ArrivalTimeMonitor` in `pcdsdevices.atm` +- Added `flow_meter` to `AttenuatorSXR_Ladder` in `pcdsdevices.attenuator` +- Added `flow_meter` to `AttenuatorSXR_LadderTwoBladeLBD` in `pcdsdevices.attenuator` +- Added `WaveFrontSensorTargetCool` and `WaveFrontSensorTargetFDQ` to `pcdsdevices.device_types` +- Added flow sensor components to `FFMirror` in `pcdsdevices.mirror` +- Added piezo pitch motors to the `ExitSlits` in `pcdsdevices.slits` New Devices ----------- -- add class `PhotonCollimator` to readout `flow_switch` in new module `pc.py` -- add class `WaveFrontSensorTargetFDQ` to read out `flow_meter` -- add class `MFXATM` in `atm.py` +- Added `PhotonCollimator` to readout `flow_switch` in new module `pcdsdevices.pc` +- Added `WaveFrontSensorTargetFDQ` to read out the `flow_meter` in `pcdsdevices.wfs` +- Added `MFXATM` to `pcdsdevices.atm` for the unique MFX ATM. Bugfixes -------- -- Fix an issue where at2l0.clear_errors would not run properly. +- Fixed an issue where `AT2L0.clear_errors` would not run properly. Maintenance ----------- -- Add missing regression tests for at2l0. -- Update versions of pre-commit checks to latest and fix new flake8 errors. +- Added missing regression tests for `AT2L0`. +- Updated versions of pre-commit checks to latest and fix new flake8 errors. Contributors ------------ @@ -43,7 +43,6 @@ Contributors - zllentz - v8.2.0 (2023-12-19) =================== From f4fc1abbcf48ab6ff6669f121682dfc1afdf524d Mon Sep 17 00:00:00 2001 From: Zachary Lentz Date: Wed, 21 Feb 2024 15:19:52 -0800 Subject: [PATCH 3/3] DOC: minor rewording and remove broken links --- docs/source/releases.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/releases.rst b/docs/source/releases.rst index 98679de76ce..e255de17be4 100644 --- a/docs/source/releases.rst +++ b/docs/source/releases.rst @@ -13,9 +13,9 @@ Features Device Updates -------------- -- Added `flow_meter` to `ArrivalTimeMonitor` in `pcdsdevices.atm` -- Added `flow_meter` to `AttenuatorSXR_Ladder` in `pcdsdevices.attenuator` -- Added `flow_meter` to `AttenuatorSXR_LadderTwoBladeLBD` in `pcdsdevices.attenuator` +- Added ``flow_meter`` to `ArrivalTimeMonitor` in `pcdsdevices.atm` +- Added ``flow_meter`` to `AttenuatorSXR_Ladder` in `pcdsdevices.attenuator` +- Added ``flow_meter`` to `AttenuatorSXR_LadderTwoBladeLBD` in `pcdsdevices.attenuator` - Added `WaveFrontSensorTargetCool` and `WaveFrontSensorTargetFDQ` to `pcdsdevices.device_types` - Added flow sensor components to `FFMirror` in `pcdsdevices.mirror` - Added piezo pitch motors to the `ExitSlits` in `pcdsdevices.slits` @@ -24,7 +24,7 @@ New Devices ----------- - Added `PhotonCollimator` to readout `flow_switch` in new module `pcdsdevices.pc` - Added `WaveFrontSensorTargetFDQ` to read out the `flow_meter` in `pcdsdevices.wfs` -- Added `MFXATM` to `pcdsdevices.atm` for the unique MFX ATM. +- Added `MFXATM` to `pcdsdevices.atm` for the unique atm unit in the MFX hutch. Bugfixes --------