From 2b5b683b4889257f98acb8f8163bb75317c92323 Mon Sep 17 00:00:00 2001 From: Zachary Lentz Date: Mon, 17 Apr 2023 10:10:50 -0700 Subject: [PATCH 1/7] DOC: simplify the glob to get around sphinx bug --- docs/source/upcoming_changes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/upcoming_changes.rst b/docs/source/upcoming_changes.rst index 1323597c056..bc5e4b4f10c 100644 --- a/docs/source/upcoming_changes.rst +++ b/docs/source/upcoming_changes.rst @@ -5,4 +5,4 @@ Upcoming Changes :maxdepth: 1 :glob: - upcoming_release_notes/[0-9]* + upcoming_release_notes/* From 5abd30866a0c0f6d0978a848bc3e7178b8f434dd Mon Sep 17 00:00:00 2001 From: Zachary Lentz Date: Mon, 17 Apr 2023 10:11:03 -0700 Subject: [PATCH 2/7] DOC: rebuild API page incidentally while testing docs --- docs/source/api.rst | 140 +++++++++++++++++++++++++++++++++++++------- 1 file changed, 120 insertions(+), 20 deletions(-) diff --git a/docs/source/api.rst b/docs/source/api.rst index 92633c89781..4cbe24f2150 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -28,6 +28,8 @@ pcdsdevices.areadetector.detectors pcdsdevices.areadetector.detectors.Basler pcdsdevices.areadetector.detectors.BaslerBase pcdsdevices.areadetector.detectors.LasBasler + pcdsdevices.areadetector.detectors.LasBaslerFF + pcdsdevices.areadetector.detectors.LasBaslerNF pcdsdevices.areadetector.detectors.PCDSAreaDetector pcdsdevices.areadetector.detectors.PCDSAreaDetectorBase pcdsdevices.areadetector.detectors.PCDSAreaDetectorEmbedded @@ -72,6 +74,8 @@ pcdsdevices.atm pcdsdevices.atm.TM1K4Target pcdsdevices.atm.TM2K2 pcdsdevices.atm.TM2K2Target + pcdsdevices.atm.TM2K4 + pcdsdevices.atm.TM2K4Target pcdsdevices.attenuator ---------------------- @@ -79,18 +83,22 @@ pcdsdevices.attenuator .. autosummary:: :toctree: generated + pcdsdevices.attenuator.AT1K2 pcdsdevices.attenuator.AT1K4 pcdsdevices.attenuator.AT2K2 pcdsdevices.attenuator.AT2L0 pcdsdevices.attenuator.AttBase pcdsdevices.attenuator.AttBaseWith3rdHarmonic + pcdsdevices.attenuator.AttBaseWith3rdHarmonicLP pcdsdevices.attenuator.Attenuator pcdsdevices.attenuator.AttenuatorCalculatorBase pcdsdevices.attenuator.AttenuatorCalculatorFilter pcdsdevices.attenuator.AttenuatorCalculatorSXR_Blade pcdsdevices.attenuator.AttenuatorCalculatorSXR_FourBlade + pcdsdevices.attenuator.AttenuatorCalculatorSXR_TwoBlade pcdsdevices.attenuator.AttenuatorCalculator_AT2L0 pcdsdevices.attenuator.AttenuatorSXR_Ladder + pcdsdevices.attenuator.AttenuatorSXR_LadderTwoBladeLBD pcdsdevices.attenuator.FEESolidAttenuatorBlade pcdsdevices.attenuator.FEESolidAttenuatorStates pcdsdevices.attenuator.FeeAtt @@ -111,7 +119,12 @@ pcdsdevices.beam_stats :toctree: generated pcdsdevices.beam_stats.BeamEnergyRequest + pcdsdevices.beam_stats.BeamEnergyRequestACRWait + pcdsdevices.beam_stats.BeamEnergyRequestNoWait pcdsdevices.beam_stats.BeamStats + pcdsdevices.beam_stats.FakeBeamEnergyRequest + pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWait + pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWait pcdsdevices.beam_stats.LCLS pcdsdevices.ccm @@ -256,8 +269,31 @@ pcdsdevices.evr .. autosummary:: :toctree: generated + pcdsdevices.evr.EvrMotor pcdsdevices.evr.Trigger +pcdsdevices.fms +--------------- + +.. autosummary:: + :toctree: generated + + pcdsdevices.fms.LCP1 + pcdsdevices.fms.LCP2 + pcdsdevices.fms.PDU_Humidity2 + pcdsdevices.fms.PDU_Humidity4 + pcdsdevices.fms.PDU_Humidity6 + pcdsdevices.fms.PDU_Humidity8 + pcdsdevices.fms.PDU_Load1 + pcdsdevices.fms.PDU_Load2 + pcdsdevices.fms.PDU_Load3 + pcdsdevices.fms.PDU_Load4 + pcdsdevices.fms.PDU_Temp2 + pcdsdevices.fms.PDU_Temp4 + pcdsdevices.fms.PDU_Temp6 + pcdsdevices.fms.PDU_Temp8 + pcdsdevices.fms.Setra5000 + pcdsdevices.gauge ----------------- @@ -311,6 +347,7 @@ pcdsdevices.inout pcdsdevices.inout.InOutPVStatePositioner pcdsdevices.inout.InOutPositioner pcdsdevices.inout.InOutRecordPositioner + pcdsdevices.inout.LightpathInOutRecordPositioner pcdsdevices.inout.Reflaser pcdsdevices.inout.TTReflaser pcdsdevices.inout.TwinCATInOutPositioner @@ -323,8 +360,9 @@ pcdsdevices.interface pcdsdevices.interface.BaseInterface pcdsdevices.interface.FltMvInterface - pcdsdevices.interface.LightpathInOutMixin + pcdsdevices.interface.LegacyLightpathMixin pcdsdevices.interface.LightpathInOutCptMixin + pcdsdevices.interface.LightpathInOutMixin pcdsdevices.interface.LightpathMixin pcdsdevices.interface.MvInterface pcdsdevices.interface.TabCompletionHelperClass @@ -390,13 +428,15 @@ pcdsdevices.lasers.btps .. autosummary:: :toctree: generated + pcdsdevices.lasers.btps.BtpsSourceStatus pcdsdevices.lasers.btps.BtpsState + pcdsdevices.lasers.btps.BtpsVGC pcdsdevices.lasers.btps.CentroidConfig pcdsdevices.lasers.btps.DestinationConfig pcdsdevices.lasers.btps.GlobalConfig + pcdsdevices.lasers.btps.LssShutterStatus pcdsdevices.lasers.btps.RangeComparison - pcdsdevices.lasers.btps.ShutterSafety - pcdsdevices.lasers.btps.SourceConfig + pcdsdevices.lasers.btps.SourceToDestinationConfig pcdsdevices.lasers.counters --------------------------- @@ -452,6 +492,11 @@ pcdsdevices.lasers.rfof pcdsdevices.lasers.rfof.CycleRfofRx pcdsdevices.lasers.rfof.CycleRfofTx + pcdsdevices.lasers.rfof.ItechRfofAll + pcdsdevices.lasers.rfof.ItechRfofErrors + pcdsdevices.lasers.rfof.ItechRfofRx + pcdsdevices.lasers.rfof.ItechRfofStatus + pcdsdevices.lasers.rfof.ItechRfofTx pcdsdevices.lasers.thorlabsWFS ------------------------------ @@ -500,6 +545,14 @@ pcdsdevices.lic pcdsdevices.lic.LICMirror pcdsdevices.lic.LaserInCoupling +pcdsdevices.light_control +------------------------- + +.. autosummary:: + :toctree: generated + + pcdsdevices.light_control.LightControl + pcdsdevices.lodcm ----------------- @@ -525,6 +578,8 @@ pcdsdevices.lodcm pcdsdevices.lodcm.SimFirstTower pcdsdevices.lodcm.SimLODCM pcdsdevices.lodcm.SimSecondTower + pcdsdevices.lodcm.XCSLODCM + pcdsdevices.lodcm.XPPLODCM pcdsdevices.lodcm.Y1 pcdsdevices.lodcm.Y2 pcdsdevices.lodcm.YagLom @@ -545,18 +600,38 @@ pcdsdevices.lxe pcdsdevices.lxe._ScaledUnitConversionDerivedSignal pcdsdevices.lxe.load_calibration_file +pcdsdevices.make_ophyd_device +----------------------------- + +.. autosummary:: + :toctree: generated + + pcdsdevices.make_ophyd_device.flatten_list + pcdsdevices.make_ophyd_device.get_components + pcdsdevices.make_ophyd_device.make_class + pcdsdevices.make_ophyd_device.make_class_line + pcdsdevices.make_ophyd_device.make_class_name + pcdsdevices.make_ophyd_device.make_cpt + pcdsdevices.make_ophyd_device.make_signal + pcdsdevices.make_ophyd_device.make_signal_wrbv + pcdsdevices.make_ophyd_device.print_class + pcdsdevices.make_ophyd_device.recurse_record + pcdsdevices.make_ophyd_device.write_file + pcdsdevices.mirror ------------------ .. autosummary:: :toctree: generated - pcdsdevices.mirror.CoatingState pcdsdevices.mirror.FFMirror pcdsdevices.mirror.FFMirrorZ pcdsdevices.mirror.Gantry pcdsdevices.mirror.KBOMirror pcdsdevices.mirror.KBOMirrorHE + pcdsdevices.mirror.KBOMirrorHEStates + pcdsdevices.mirror.KBOMirrorStates + pcdsdevices.mirror.MirrorInsertState pcdsdevices.mirror.OMMotor pcdsdevices.mirror.OffsetMirror pcdsdevices.mirror.OpticsPitchNotepad @@ -567,15 +642,9 @@ pcdsdevices.mirror pcdsdevices.mirror.XOffsetMirrorBend pcdsdevices.mirror.XOffsetMirrorRTDs pcdsdevices.mirror.XOffsetMirrorState + pcdsdevices.mirror.XOffsetMirrorStateCool pcdsdevices.mirror.XOffsetMirrorSwitch - -pcdsdevices.misc ----------------- - -.. autosummary:: - :toctree: generated - - pcdsdevices.misc.MyDevice2 + pcdsdevices.mirror.XOffsetMirrorXYState pcdsdevices.movablestand ------------------------ @@ -632,14 +701,6 @@ pcdsdevices.mrco_motion pcdsdevices.mrco_motion.MRCO -pcdsdevices.my_device ---------------------- - -.. autosummary:: - :toctree: generated - - pcdsdevices.my_device.MyDevice - pcdsdevices.piezo ----------------- @@ -678,6 +739,14 @@ pcdsdevices.pmps pcdsdevices.pmps.TwinCATStatePMPS +pcdsdevices.pneumatic +--------------------- + +.. autosummary:: + :toctree: generated + + pcdsdevices.pneumatic.BeckhoffPneumatic + pcdsdevices.positioner ---------------------- @@ -745,6 +814,14 @@ pcdsdevices.pv_positioner pcdsdevices.pv_positioner.PVPositionerDone pcdsdevices.pv_positioner.PVPositionerIsClose +pcdsdevices.radiation +--------------------- + +.. autosummary:: + :toctree: generated + + pcdsdevices.radiation.HPI6030 + pcdsdevices.ref --------------- @@ -754,6 +831,15 @@ pcdsdevices.ref pcdsdevices.ref.ReflaserL2SI pcdsdevices.ref.ReflaserL2SIMirror +pcdsdevices.rs_powersupply +-------------------------- + +.. autosummary:: + :toctree: generated + + pcdsdevices.rs_powersupply.RSChannel + pcdsdevices.rs_powersupply.RohdeSchwarzPowerSupply + pcdsdevices.rtds_ebd -------------------- @@ -764,6 +850,7 @@ pcdsdevices.rtds_ebd pcdsdevices.rtds_ebd.RTDSBase pcdsdevices.rtds_ebd.RTDSK0 pcdsdevices.rtds_ebd.RTDSL0 + pcdsdevices.rtds_ebd.RTDSX0ThreeStage pcdsdevices.sample_delivery --------------------------- @@ -831,6 +918,7 @@ pcdsdevices.signal pcdsdevices.signal.PytmcSignalRO pcdsdevices.signal.PytmcSignalRW pcdsdevices.signal.SignalEditMD + pcdsdevices.signal.SummarySignal pcdsdevices.signal.UnitConversionDerivedSignal pcdsdevices.signal._OptionalEpicsSignal pcdsdevices.signal.pytmc_writable @@ -873,6 +961,8 @@ pcdsdevices.spectrometer .. autosummary:: :toctree: generated + pcdsdevices.spectrometer.Gen1VonHamos4Crystal + pcdsdevices.spectrometer.Gen1VonHamosCrystal pcdsdevices.spectrometer.HXRSpectrometer pcdsdevices.spectrometer.Kmono pcdsdevices.spectrometer.Mono @@ -949,6 +1039,14 @@ pcdsdevices.timetool pcdsdevices.timetool.Timetool pcdsdevices.timetool.TimetoolWithNav +pcdsdevices.usb_encoder +----------------------- + +.. autosummary:: + :toctree: generated + + pcdsdevices.usb_encoder.UsDigitalUsbEncoder + pcdsdevices.utils ----------------- @@ -985,6 +1083,8 @@ pcdsdevices.valve pcdsdevices.valve.GateValve pcdsdevices.valve.VCN + pcdsdevices.valve.VCN_VAT590 + pcdsdevices.valve.VCN_VAT590_Status pcdsdevices.valve.VFS pcdsdevices.valve.VGC pcdsdevices.valve.VGCLegacy From bd753f21902020385c505018e6574582d1138203 Mon Sep 17 00:00:00 2001 From: Zachary Lentz Date: Mon, 17 Apr 2023 10:15:17 -0700 Subject: [PATCH 3/7] DOC: run the docs build script for v7.2.1 --- docs/source/releases.rst | 31 ++++++++++++++++++ .../1095-lodcm_energy.rst | 32 ------------------- ...nfiguration_method_to_LasBasler_camera.rst | 31 ------------------ ...size_control_to_PCDSAreaDetectorTyphos.rst | 30 ----------------- 4 files changed, 31 insertions(+), 93 deletions(-) delete mode 100644 docs/source/upcoming_release_notes/1095-lodcm_energy.rst delete mode 100644 docs/source/upcoming_release_notes/1129-Add_configuration_method_to_LasBasler_camera.rst delete mode 100644 docs/source/upcoming_release_notes/974-Add_binning_and_region_size_control_to_PCDSAreaDetectorTyphos.rst diff --git a/docs/source/releases.rst b/docs/source/releases.rst index b4fa4bc1ab0..29f9600c264 100644 --- a/docs/source/releases.rst +++ b/docs/source/releases.rst @@ -2,6 +2,37 @@ Release History ############### +v7.2.1 (2023-04-17) +=================== + +API Changes +----------- +- Add energy setpoint and tweakX to the LODCM class + +Features +-------- +- Set LODCM energy directly + +Device Updates +-------------- +- lodcm.py: fix energy functionality, add commonly used aliases +- LasBasler: Add a new signal that can be used to auto-configure a camera based on an internal dictionary. + +New Devices +----------- +- PCDSAreaDetectorTyphos class: Add in signals for camera binning and region size control. +- LasBaslerNF: A Basler camera intended to be used as a near-field diagnostic. +- LasBaslerFF: A Basler camera intended to be used as a far-field diagnostic. + +Contributors +------------ +- espov +- tangkong +- tjohnson +- zllentz + + + v7.2.0 (2023-04-04) =================== diff --git a/docs/source/upcoming_release_notes/1095-lodcm_energy.rst b/docs/source/upcoming_release_notes/1095-lodcm_energy.rst deleted file mode 100644 index 31b24821263..00000000000 --- a/docs/source/upcoming_release_notes/1095-lodcm_energy.rst +++ /dev/null @@ -1,32 +0,0 @@ -1095 lodcm_energy -################# - -API Changes ------------ -- Add energy setpoint and tweakX to the LODCM class - -Features --------- -- Set LODCM energy directly - -Device Updates --------------- -- lodcm.py: fix energy functionality, add commonly used aliases - -New Devices ------------ -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- espov -- tangkong -- zllentz diff --git a/docs/source/upcoming_release_notes/1129-Add_configuration_method_to_LasBasler_camera.rst b/docs/source/upcoming_release_notes/1129-Add_configuration_method_to_LasBasler_camera.rst deleted file mode 100644 index 1302618f5dd..00000000000 --- a/docs/source/upcoming_release_notes/1129-Add_configuration_method_to_LasBasler_camera.rst +++ /dev/null @@ -1,31 +0,0 @@ -1129 Add configuration method to LasBasler camera -################# - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- LasBasler: Add a new signal that can be used to auto-configure a camera based on an internal dictionary. - -New Devices ------------ -- LasBaslerNF: A Basler camera intended to be used as a near-field diagnostic. -- LasBaslerFF: A Basler camera intended to be used as a far-field diagnostic. - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- tjohnson diff --git a/docs/source/upcoming_release_notes/974-Add_binning_and_region_size_control_to_PCDSAreaDetectorTyphos.rst b/docs/source/upcoming_release_notes/974-Add_binning_and_region_size_control_to_PCDSAreaDetectorTyphos.rst deleted file mode 100644 index 9bdcbc37fb6..00000000000 --- a/docs/source/upcoming_release_notes/974-Add_binning_and_region_size_control_to_PCDSAreaDetectorTyphos.rst +++ /dev/null @@ -1,30 +0,0 @@ -974 Add binning and region size control to PCDSAreaDetectorTyphos -################# - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Device Updates --------------- -- N/A - -New Devices ------------ -- PCDSAreaDetectorTyphos class: Add in signals for camera binning and region size control. - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- tjohnson From 690753771177af6989a49a21bc0d636d14b9608e Mon Sep 17 00:00:00 2001 From: Zachary Lentz Date: Mon, 17 Apr 2023 10:21:19 -0700 Subject: [PATCH 4/7] Revert "DOC: simplify the glob to get around sphinx bug" This reverts commit 2b5b683b4889257f98acb8f8163bb75317c92323. --- docs/source/upcoming_changes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/upcoming_changes.rst b/docs/source/upcoming_changes.rst index bc5e4b4f10c..1323597c056 100644 --- a/docs/source/upcoming_changes.rst +++ b/docs/source/upcoming_changes.rst @@ -5,4 +5,4 @@ Upcoming Changes :maxdepth: 1 :glob: - upcoming_release_notes/* + upcoming_release_notes/[0-9]* From 90483e3e907388f66424bb6e24fabdb57d34c1ad Mon Sep 17 00:00:00 2001 From: Zachary Lentz Date: Mon, 17 Apr 2023 10:27:48 -0700 Subject: [PATCH 5/7] DOC: consolidate, mark as not an API break --- docs/source/releases.rst | 13 ++----------- 1 file changed, 2 insertions(+), 11 deletions(-) diff --git a/docs/source/releases.rst b/docs/source/releases.rst index 29f9600c264..93c6849b555 100644 --- a/docs/source/releases.rst +++ b/docs/source/releases.rst @@ -1,21 +1,13 @@ Release History ############### - v7.2.1 (2023-04-17) =================== -API Changes ------------ -- Add energy setpoint and tweakX to the LODCM class - -Features --------- -- Set LODCM energy directly - Device Updates -------------- -- lodcm.py: fix energy functionality, add commonly used aliases +- LODCM: Add energy setpoint and tweakXC. +- LODCM: fix energy functionality and add commonly used aliases. - LasBasler: Add a new signal that can be used to auto-configure a camera based on an internal dictionary. New Devices @@ -32,7 +24,6 @@ Contributors - zllentz - v7.2.0 (2023-04-04) =================== From f184f6a023cb20571d1d48878c87408bdbbf5557 Mon Sep 17 00:00:00 2001 From: Zachary Lentz Date: Mon, 17 Apr 2023 10:28:55 -0700 Subject: [PATCH 6/7] DOC: change my mind about the release number, not a bugfix rel --- docs/source/releases.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/releases.rst b/docs/source/releases.rst index 93c6849b555..62662cb9d85 100644 --- a/docs/source/releases.rst +++ b/docs/source/releases.rst @@ -1,7 +1,7 @@ Release History ############### -v7.2.1 (2023-04-17) +v7.3.0 (2023-04-17) =================== Device Updates From 93ee4c27bff73b1b27888b01978d57fe6441d404 Mon Sep 17 00:00:00 2001 From: Zachary Lentz Date: Mon, 17 Apr 2023 10:36:39 -0700 Subject: [PATCH 7/7] DOC: github usernames --- 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 62662cb9d85..b7b987aa987 100644 --- a/docs/source/releases.rst +++ b/docs/source/releases.rst @@ -18,9 +18,9 @@ New Devices Contributors ------------ -- espov +- slactjohnson - tangkong -- tjohnson +- vespos - zllentz