Xibs

Release `0.8.0` brings auto-recomputing functionality and CUDA GPU compatibility for the kick-based IBS.

Package Changes

**New Functionality**

- The kick classes' internals was rewritten in order to use the `particles`'s context for computations. This brings compatibility for the `xobjects.ContextCupy` context.
- Implemented an auto-recompute of the growth rates functionality for analytical classes.
- Implemented an auto-recompute of the kick coefficients functionality for kick classes.

**Changes:**

- Analytical classes do not raise and error if no growth rates have been computed when calling `.emittance_evolution`. Instead, they will log and compute them first.
- Kick classes do not raise and error if no kick coefficients have been computed when calling `.apply_ibs_kick`. Instead, they will log and compute them first.

**Maintenance**

- Added tests for all new functionality.

Documentation Changes

- Added example galleries for the auto-recomputing features.
- Added an FAQ section about the auto-recomputing features.
- Performed significant cleanup of the example gallery scripts to be more consistent between one another, and use the (private) convenience functions that work on device.

Other Changes

- Removed buggy badge from README.
- Renamed and cleanup up all benchmark scripts to be clearer about their purpose.
- Added private helpers in formulary to perform on-device (GPU compatible) computations for bunch length etc.

A big thanks to ewaagaard for testing this branch on CUDA devices.
See the [documentation](https://fsoubelet.github.io/xibs/) for details on all new functionality.


**Full Changelog**: https://github.com/fsoubelet/xibs/compare/0.7.1...0.8.0

Release `0.7.1` brings a fix to the Coulomb logarithm calculation.

Package Changes

**Fixes**

- Properly use the absolute value of the particle charge in the Coulomb log calculation.
- Properly convert from sigd to sige in a formula in the Coulomb log calculation, which is important for low energy beams.

See the [documentation](https://fsoubelet.github.io/xibs/) for details.

What's Changed

**Full Changelog**: https://github.com/fsoubelet/xibs/compare/0.7.0...0.7.1

Release `0.7.0` brings a second formalism for IBS kicks functionality.

Package Changes

**New Functionality**

- IBS kicks following the formalism introduced by [P. Zenkevich et al](https://www.sciencedirect.com/science/article/abs/pii/S0168900206000465?via%3Dihub) has been implemented (using terms from Nagaitsev's formalism as [derived by M. Zampetakis](https://indico.cern.ch/event/1140639/contributions/4786442/attachments/2414483/4131353/Implementation_of_IBS_kicks_for_the_LHC_Ion_Injectors_ABP_24_3_22.pdf)), in the `xibs.kicks` module.

**Maintenance**

- Added tests for new functionality.

Documentation Changes

- Added an documentation for the new functionality's API.
- Added gallery examples for kinetic kicks and for comparison to simple kicks.
- Fixed some typos and mistakes in the FAQ.

See the [documentation](https://fsoubelet.github.io/xibs/) for details.

**Full Changelog**: https://github.com/fsoubelet/xibs/compare/0.6.0...0.7.0

Release `0.6.0` adds the possibility for the user to also provide to include the Synchrotron Radiation contribution to emittance evolutions analytically.

Package Changes

**New Functionality**

- The user can now provide equilibrium emittances & momentum spread as well as damping times from synchrotron radiation and quantum excitation when computing the emittance evolutions analytically.

**Maintenance**

- Added tests for new functionality.

Documentation Changes

- Added an FAQ section about SR contribution and how to get the relevant quantities from either `Xsuite` or `MAD-X`.
- The FAQ part of the documentation has been split into modules.
- Miscellaneous updates were made to other parts of the documentation.

Other Changes

- Updated CI to use the newer action version for `codecov`.

See the [documentation](https://fsoubelet.github.io/xibs/) for details.

**Full Changelog**: https://github.com/fsoubelet/xibs/compare/0.5.0...0.6.0

Release `0.5.0` brings a first formalism for IBS kicks functionality.

Package Changes


**New Functionality**

- IBS kicks following the formalism introduced by [R. Bruce et al](https://journals.aps.org/prab/pdf/10.1103/PhysRevSTAB.13.091001) has been implemented, in the `xibs.kicks` module.

**Maintenance**

- Fixed some tests to adapt to new versions of dependencies.
- Changed the error raised in analytical classes if computing emittances evolutions without having computed growth rates from `ValueError` to `AttributeError`.

Documentation Changes

- Added an example gallery for simple kicks.

Other Changes

- Added dependabot integration to the repository.
- Updated the actions/upload-artifacts version used in CI.

See the [documentation](https://fsoubelet.github.io/xibs/) for details on all new functionality.

**Full Changelog**: https://github.com/fsoubelet/xibs/compare/0.4.1...0.5.0

Release `0.4.1` is a patch release which fixes an incomplete API from the previous release.

In `0.4.0`, the `bunched` boolean argument was introduced in analytical classes's `.growth_rates` methods. However, it was only implemented for the Bjorken & Mtingwa formalism and not the Nagaitsev formalism

In this release the approximation suggested by Piwinski is introducted and used for the Nagaitsev formalism if `bunched=False` is given. It uses the Coulomb logarithm for a coasting beam and considers `Circumference / (2*pi)` for the bunch length.

Please note that this is an approximation and is to be expected deviating from correct values. For a guarantee of correct rates with coasting beams, use the `BjorkenMtingwaIBS` class.