Skip to content

Commit

Permalink
Merge pull request pcdshub#1277 from tangkong/rel_v8.5.0
Browse files Browse the repository at this point in the history
REL: Release notes v8.5.0
  • Loading branch information
ZLLentz authored Aug 26, 2024
2 parents 57a6939 + 36ed446 commit b33b7c4
Show file tree
Hide file tree
Showing 32 changed files with 123 additions and 936 deletions.
18 changes: 18 additions & 0 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -273,11 +273,13 @@ pcdsdevices.epics_motor
pcdsdevices.epics_motor.OffsetIMSWithPreset
pcdsdevices.epics_motor.OffsetMotor
pcdsdevices.epics_motor.PCDSMotorBase
pcdsdevices.epics_motor.PI_M824
pcdsdevices.epics_motor.PMC100
pcdsdevices.epics_motor.SmarAct
pcdsdevices.epics_motor.SmarActEncodedTipTilt
pcdsdevices.epics_motor.SmarActOpenLoop
pcdsdevices.epics_motor.SmarActOpenLoopPositioner
pcdsdevices.epics_motor.SmarActPicoscale
pcdsdevices.epics_motor.SmarActTipTilt

pcdsdevices.eps
Expand Down Expand Up @@ -599,6 +601,7 @@ pcdsdevices.lic_2d_tmo
.. autosummary::
:toctree: generated

pcdsdevices.lic_2d_tmo.LaserCouplingStates
pcdsdevices.lic_2d_tmo.TMOLaserInCouplingTwoDimension

pcdsdevices.light_control
Expand Down Expand Up @@ -691,18 +694,21 @@ pcdsdevices.mirror
pcdsdevices.mirror.KBOMirrorHEStates
pcdsdevices.mirror.KBOMirrorStates
pcdsdevices.mirror.MirrorInsertState
pcdsdevices.mirror.MirrorStripe2D4P
pcdsdevices.mirror.OMMotor
pcdsdevices.mirror.OffsetMirror
pcdsdevices.mirror.OpticsPitchNotepad
pcdsdevices.mirror.Pitch
pcdsdevices.mirror.PointingMirror
pcdsdevices.mirror.TwinCATMirrorStripe
pcdsdevices.mirror.XOffsetMirror
pcdsdevices.mirror.XOffsetMirror2D4PState
pcdsdevices.mirror.XOffsetMirrorBend
pcdsdevices.mirror.XOffsetMirrorNoBend
pcdsdevices.mirror.XOffsetMirrorRTDs
pcdsdevices.mirror.XOffsetMirrorState
pcdsdevices.mirror.XOffsetMirrorStateCool
pcdsdevices.mirror.XOffsetMirrorStateCoolNoBend
pcdsdevices.mirror.XOffsetMirrorSwitch
pcdsdevices.mirror.XOffsetMirrorXYState

Expand Down Expand Up @@ -881,6 +887,7 @@ pcdsdevices.pv_positioner
.. autosummary::
:toctree: generated

pcdsdevices.pv_positioner.OnePVMotor
pcdsdevices.pv_positioner.PVPositionerComparator
pcdsdevices.pv_positioner.PVPositionerDone
pcdsdevices.pv_positioner.PVPositionerIsClose
Expand Down Expand Up @@ -1066,7 +1073,9 @@ pcdsdevices.spectrometer
pcdsdevices.spectrometer.TMOSpectrometer
pcdsdevices.spectrometer.TMOSpectrometerSOLIDATTStates
pcdsdevices.spectrometer.VonHamos4Crystal
pcdsdevices.spectrometer.VonHamos6Crystal
pcdsdevices.spectrometer.VonHamosCrystal
pcdsdevices.spectrometer.VonHamosCrystal_2
pcdsdevices.spectrometer.VonHamosFE
pcdsdevices.spectrometer.VonHamosFER

Expand Down Expand Up @@ -1148,6 +1157,15 @@ pcdsdevices.timetool
pcdsdevices.timetool.Timetool
pcdsdevices.timetool.TimetoolWithNav

pcdsdevices.tmo_ip1
-------------------

.. autosummary::
:toctree: generated

pcdsdevices.tmo_ip1.CalibrationAxis
pcdsdevices.tmo_ip1.SCaFoil

pcdsdevices.tpr
---------------

Expand Down
105 changes: 105 additions & 0 deletions docs/source/releases.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,111 @@
Release History
###############


v8.5.0 (2024-08-22)
===================

Features
--------
- `MstaEnum`: Enum describing the motor record MSTA bits.
- `NewportMstaEnum`: Enum describing the special Newport motor record MSTA bits.
- `IMSMstaEnum`: Enum describing the special IMS motor record MSTA bits.

Device Updates
--------------
- Includes new PV RBVs for Picoscale at motor level: `pico_present`, `pico_exists`, `pico_sig_qual`, `pico_enable`.
- Includes new PV RBVs for Picoscale at controller level: `pico_stable`, `pico_name`, `pico_wmin` (working distance min), `pico_wmax` (working distance max).
- Add state mover to LI2K4.
- Added ``RST_SW`` pv to Ebara EVA pumps. This PV is used to reset alarm errors.
- Added ``PI_M824`` motor class for MEC hexapod motors.
- `TprTrigger`: change delay_setpoint and width_setpoint to kind=config.
- `TprTrigger`: Make LCLS2 timing the default timing_mode.
- `XOffsetMirrorNoBend` in mirror.py gets 3 new cooling readout components.
- `Mono` in spectrometer.py gets 4 new RTD components and re-named RTDs 1-8. Also, Made cooling component names consistent with mirror cooling component names.
- ST1K4 can move freely without automode.
- `EpicsMotorInterface`: Add a "raw" MSTA value, as well as the interpreted
values as a dictionary. Adds a "homed" property based on this. Uses a "generic"
MstaEnum class.
- `Newport`: Add a "raw" MSTA value, as well as the interpreted values as a
dictionary. Adds a "homed" property based on this. Uses the `NewportMstaEnum`
class.
- `IMS`: Add a "raw" MSTA value, as well as the interpreted values as a
dictionary. Adds a "homed" property based on this. Uses the `IMSMstaEnum`
class.
- `btps.BtpsState`: add LS3, LS4, and LS6
- `btps.DestinationConfig`: add LS3, LS4, and LS6
- `btms_config.SourcePosition`: add LS3, LS4, and LS6
- `btms_config.valid_sources`: add LS3, LS4, and LS6
- UI file updates to support above device updates
- `sqr1`: overwrite SQR1Axis set method to avoid waiting and setpoints synchronization.
- `FFMirrorZ` updated to read out flow sensors for ``MR4K4`` and ``MR5K4``.
- `lasers.btms_config.SourcePosition`: Add a new method to get the happi device
name, turn the PV name into a dictionary rather than generating from bay
number.
- `IMS`: Move VBAS and VMAX signals into EpicsMotorInterface parent class.
- `EpicsMotorInterface`: Update tab_whitelist for ``.VBAS`` and ``.VMAX`` signals.

New Devices
-----------
- added `SmarActPicoscale` subclass of SmarAct.
- adds `MirrorStripe2D4P` for coating states with 2 dimensional position state movers with PMPS.
- adds `XOffsetMirror2D4PState` for OffsetMirrors with 2D 4Position coating states.
- adding new device PA1K4-PF
- Adds `OnePvMotor`: a pv_positioner that simply writes to and reads from a single PV.
This could be useful if you encounter a reason to use the motor interface on
non-motor PVs.
- `XOffsetMirrorStateCoolNoBend` is added to support ``MR1K4``.
- `VonHamos6Crystal`: New MFX 6-crystals spectrometer running on plc-mfx-motion. Contains 6 crystals motions + 3 translations and 1 rotation for the base.
- `VonHamosCrystal_2`: interface to the motor stack of a single crystal in the spectrometer.

Bugfixes
--------
- Overwrite ``velocity_max`` and ``velocity_base`` signals for ``Newport``
class to fix a bug that prevented these motors from moving.
- `BtpsState``: Fix mis-match of LS3 and LS4 PVs.
- Prevent some devices from creating threads at high frequency when
trying to get the lightpath state. These devices classes include
`XOffsetMirrorXYState`, `AttenuatorSXR_Ladder`,
`AttenuatorSXR_LadderTwoBladeLBD`, `AT2L0`, `XCSLODCM`, and `XPPLODCM`
- `SmarActEncodedTipTilt``: Fix typo in tilt axis instantiation.
- Replace the broken motor "disabled" (.DISP) typhos widget with a bitmask toggle button.
- Properly fill the `sys` keyword argument in `TprTrigger.ns_delay_scan`
- `btms_config.DestinationPosition`: fix description of RIX IP3
- `btms_config.valid_destinations`: fix description of RIX IP3
- Implement a workaround for an issue where `Lcls2LaserTiming` could not be scanned
with small scan steps.
- Remove two targets from the tmo spectrometer's foil attenuator.
These were removed from the PLC/IOC.
This fixes an issue where the state device was not moveable.
- Fix an issue with classes like `IMS` and `Newport` where calling
``set_current_position`` on a position outside of the user limits
would fail, rather than change the limits to support the new
offsets.

Maintenance
-----------
- Allow motion uis to expand vertically once this functionality gets added to typhos.
- Use sympy instead of pint for unit conversions for simpler
maintainability.
- Various CI tweaks due to numpy 2.0's chaos.
- Modifies entrypoint tests to be forward-compatible with py3.12 entrypoint API.
- Unpins numpy in CI, build incompatibility has been fixed upstream.

Contributors
------------
- aberges-SLAC
- baljamal
- ghalym
- jozamudi
- nrwslac
- rcjwoods
- slactjohnson
- tangkong
- tongju12
- vespos
- zllentz


v8.4.0 (2024-04-16)
===================

Expand Down
32 changes: 0 additions & 32 deletions docs/source/upcoming_release_notes/1186-enh_onepvmotor.rst

This file was deleted.

30 changes: 0 additions & 30 deletions docs/source/upcoming_release_notes/1188-update_ebara_eva_class.rst

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

30 changes: 0 additions & 30 deletions docs/source/upcoming_release_notes/1223-bld_unpin_numpy.rst

This file was deleted.

Loading

0 comments on commit b33b7c4

Please sign in to comment.