Skip to content

Latest commit

 

History

History
183 lines (117 loc) · 8.79 KB

CHANGELOG.md

File metadata and controls

183 lines (117 loc) · 8.79 KB
Raw

Changelog

v0.7.0 [🚧 Work in Progress]

🚨 Breaking Changes

  • Cheetah is now vectorised. This means that you can run multiple simulations in parallel by passing a batch of beams and settings, resulting a number of interfaces being changed. For Cheetah developers this means that you now have to account for an arbitrary-dimensional tensor of most of the properties of you element, rather than a single value, vector or whatever else a property was before. (see #116, #157, #170, #172, #173, #198, #215, #218, #229, #233) (@jank324, @cr-xu, @hespe)
  • The fifth particle coordinate s is renamed to tau. Now Cheetah uses the canonical variables in phase space $(x,px=\frac{P_x}{p_0},y,py, \tau=c\Delta t, \delta=\Delta E/{p_0 c})$. In addition, the trailing "s" was removed from some beam property names (e.g. beam.xs becomes beam.x). (see #163) (@cr-xu)

🚀 Features

  • CustomTransferMap elements created by combining multiple other elements will now reflect that in their name attribute (see #100) (@jank324)
  • Add a new class method for ParticleBeam to generate a 3D uniformly distributed ellipsoidal beam (see #146) (@cr-xu, @jank324)
  • Add Python 3.12 support (see #161) (@jank324)
  • Implement space charge using Green's function in a SpaceChargeKick element (see #142) (@greglenerd, @RemiLehe, @ax3l, @cr-xu, @jank324)
  • Segments can now be imported from Bmad to devices other than torch.device("cpu") and dtypes other than torch.float32 (see #196, #206) (@jank324)
  • Screen now offers the option to use KDE for differentiable images (see #200) (@cr-xu, @roussel-ryan)
  • Moving Elements and Beams to a different device and changing their dtype like with any torch.nn.Module is now possible (see #209) (@jank324)
  • Quadrupole now supports tracking with Cheetah's matrix-based method or with Bmad's more accurate method (see #153) (@jp-ga, @jank324)

🐛 Bug fixes

  • Now all Element have a default length of torch.zeros((1)), fixing occasional issues with using elements without length, such as Marker, BPM, Screen, and Aperture. (see #143) (@cr-xu)
  • Fix bug in Cavity _track_beam (see #150) (@jp-ga)
  • Fix issue where dipoles would not get a unique name by default (see #186) (@hespe)
  • Add name to Drift element __repr__ (see #201) (@ansantam)
  • Fix bug where dtype was not used when creating a ParameterBeam from Twiss parameters (see #206) (@jank324)
  • Fix bug after running Segment.inactive_elements_as_drifts the drifts could have the wrong dtype (see #206) (@jank324)
  • Fix an issue where splitting elements would result in splits with a different dtype (see #211) (@jank324)
  • Pin to NumPy 1.X due to compatibility issues on Windows (see #220) (@hespe)

🐆 Other

  • Update versions of some steps used by GitHub actions to handle Node.js 16 end-of-life (@jank324)
  • Update versions in pre-commit config (see #148) (@jank324)
  • Split accelerator and beam into separate submodules (see #158) (@jank324)
  • Update reference from arXiv preprint to PRAB publication (see #166) (@jank324)
  • Rename converter modules to the respective name of the accelerator code (see #167) (@jank324)
  • Added imports to the code example in the README (see #188) (@jank324)
  • Refactor definitions of physical constants (see #189) (@hespe)
  • Fix the quadrupole strength units in the quadrupole docstring (see #202) (@ansantam)
  • Add CI runs for macOS (arm64) and Windows (see #226) (@cr-xu, @jank324, @hespe)

v0.6.3 (2024-03-28)

🐛 Bug fixes

  • Fix bug in Cavity transfer map bug. (see #129 and #135) (@cr-xu)

🐆 Other

  • Add GPL 3 licence (see #131) (@jank324)

v0.6.2 (2024-02-13)

🚨 Breaking Changes

  • The handling of device and dtype was overhauled. They might not behave as expected. Elements also no longer have a device attribute. (see #115) (@jank324)

🚀 Features

  • Add charge to the ParameterBeam and ParticleBeam classes (see #86) (@cr-xu)
  • Add opt-in speed optimisations (see #88) (@jank324)

🐛 Bug fixes

  • Fix the transfer maps in Drift and Dipole; Add R56 in horizontal and vertical correctors modelling (see #90) (@cr-xu)
  • Fix fringe_field_exit of Dipole is overwritten by fringe_field bug (see #99) (@cr-xu)
  • Fix error caused by mismatched devices on machines with CUDA GPUs (see #97 and #115) (@jank324)
  • Fix error raised when tracking a ParameterBeam through an active BPM (see #101) (@jank324)
  • Fix error in ASTRA beam import where the energy was set to float64 instead of float32 (see #111) (@jank324)
  • Fix missing passing of total_charge in ParameterBeam.transformed_to (see #112) (@jank324)
  • Fix Cavitiy.__repr__ printing voltage value for phase property (see #121) (@jank324)

🐆 Other

  • Add pull request template (see #97) (@jank324)
  • Add Acknowledgements section to README (see #103) (@jank324)
  • benchmark directory was moved to desy-ml/cheetah-demos repository (see #108) (@jank324)
  • Update citations to new arXiv preprint (see #117) (@jank324)
  • Improve the docstring with proper units for the phase space dimensions (see #122) (@cr-xu)
  • Link to the new paper (on arXiv) in the documentation (see #125) (@jank324)

v0.6.1 (2023-09-17)

🐛 Bug fixes

  • Fix issue where converters submodule was not installed properly (see 1562496) (@jank324)

v0.6.0 (2023-09-15)

🚨 Breaking Changes

  • Cheetah elements are now subclasses of torch.nn.Module, where the parameters should always be torch.Tensor. This makes cheetah a fully differentiable simulation code. (see #11)
  • The cell keyword argument of cheetah.Segment has been renamed to elements.
  • Element and beam parameters must now always be passed to the constructor or set afterwards as a torch.Tensor. It is no longer possible to use float, int or np.ndarray. (see #11)

🚀 Features

  • Convert from Bmad lattices files (see #65) (@jank324)
  • Add proper transfer map for cavity (see #65) (@jank324, @cr-xu)
  • Twiss parameter calculation and generate new beam from twiss parameter (see #62) (@jank324, @cr-xu)
  • Saving and loading lattices from LatticeJSON (see #9) (@cr-xu)
  • Nested Segments can now be flattened (@jank324)
  • Ocelot converter adds support for Cavity, TDCavity, Marker, Monitor, RBend, SBend, Aperture and Solenoid (see #78) (@jank324)

🐛 Bug fixes

  • Fix dependencies on readthedocs (see #54) (@jank324)
  • Fix error when tracking ParameterBeam through segment on CPU (see #68) (@cr-xu)

🐆 Other

  • Add CHANGELOG.md (see #74)
  • Improved documentation on converting Marker object into cheetah (see #58) (#jank324)

v0.5.19 (2023-05-22)

🚀 Features

  • Better error messages when beam and accelerator devices don't match (@FelixTheilen)

🐛 Bug fixes

  • Fix BPM issue with ParameterBeam (@FelixTheilen)
  • Fix wrong screen reading dimensions (@cr-xu)

🐆 Other

  • Improve docstrings (@FelixTheilen)
  • Implement better testing with pytest (@FelixTheilen)
  • Setup formatting with black and isort as well as flake8 listing (@cr-xu)
  • Add type annotations (@jank324)
  • Setup Sphinx documentation on readthedocs (@jank324)

v0.5.18 (2023-02-06)

🐛 Bug Fixes

  • Fix issue where multivariate_normal() crashes because cov is not positive-semidefinite.

v0.5.17 (2023-02-05)

🚀 New Features

  • Faster screen reading simulation by using torch.histogramdd()

v0.5.16 (2023-02-02)

🐛 Bug Fixes

  • Fix bug where some screens from the ARES Ocelot lattice were converted to Drift elements.

v0.5.15 (2022-10-12)

🚀 New Features

  • Ocelot has been removed as a mandatory dependency and is now only needed when someone wants to convert from Ocelot objects.

🐛 Bug Fixes

  • An error that only packages with all dependencies available on PyPI can be installed from PyPI has been fixed.

v0.5.14 (2022-09-28)

🚀 Features

  • Introduce black for code formatting and isort for import organisation.
  • Prepare release on PyPI as cheetah-accelerator.

v0.5.13 (2022-07-26)

🚀 Features

  • Add caching of Screen.reading to avoid expensive recomputation

🐛 Bug Fixes

  • Fix install dependencies

v0.5.12 (2022-06-16)

  • First Release of Cheetah 🐆🎉