Release 0.4.0

[lfarv]

A new version may be released. It's a minor maintenance version before releasing 1.0 I propose to postpone the description of deprecated features to the 1.0 version.

This branch includes improved developer notes describing the proposed release procedure,

This release may still wait for the pending minor modifications.

The proposed release notes are:

Main modifications

This releases introduces:

• Time-dependent multipole strengths (sine wave, white noise, user-defined)
• Updated values of the physical constants
• Compatibility with python 3.11
• 3d element rotations (tilt, pitch, yaw)
• Plot of the Σ beam matrix
• Multibunch Wakefield
• Multibunch beamloading
• Beam monitor element (statistics on the particle distribution)
• Extend the definition of refpts to string patterns, regular expressions, None, All, End special values
• Improved documentation and examples

Bug fixes

• quantpass bugfixes by @swhite2401 in https://github.com/atcollab/at/pull/504
• Take "QuantPass" into account when checking 6D motion by @lfarv in https://github.com/atcollab/at/pull/507
• Failure of GitHub action for Matlab compilation error by @lfarv in https://github.com/atcollab/at/pull/535
• at.sigma_matrix bug fix by @lfarv in https://github.com/atcollab/at/pull/536
• Fix bug in convolve_wakefun by @lcarver in https://github.com/atcollab/at/pull/550
• Bug fix on atrotatelattice by @lfarv in https://github.com/atcollab/at/pull/569
• Fix circular imports by @lfarv in https://github.com/atcollab/at/pull/570
• BugFix: refpts=None in get_lifetime by @swhite2401 in https://github.com/atcollab/at/pull/580
• Fix bug in memory allocation of wake method by @lcarver in https://github.com/atcollab/at/pull/579
• Correct return type of wakefunc_long_resonator by @lfarv in https://github.com/atcollab/at/pull/591
• Fix compilation with OPENMP=1 by @lfarv in https://github.com/atcollab/at/pull/607

New features

• Multibunch wakefieldpass by @swhite2401 in https://github.com/atcollab/at/pull/493
• Introduce an RF frequency shift input to specify off-momentum computation by @lfarv in https://github.com/atcollab/at/pull/505
• Variable multipole by @swhite2401 in https://github.com/atcollab/at/pull/510
• Improve patpass by @lfarv in https://github.com/atcollab/at/pull/515
• Upgrade scipy requirement to 1.4.0 by @lfarv in https://github.com/atcollab/at/pull/520
• Python 3.11 by @lfarv in https://github.com/atcollab/at/pull/523
• Element rotations by @swhite2401 in https://github.com/atcollab/at/pull/519
• Multibunch Beamloading by @swhite2401 in https://github.com/atcollab/at/pull/516
• Beam monitor by @swhite2401 in https://github.com/atcollab/at/pull/521
• Update the python version spec by @lfarv in https://github.com/atcollab/at/pull/526
• random generators compatibility with parallel processing by @lfarv in https://github.com/atcollab/at/pull/513
• Unfold beam by @swhite2401 in https://github.com/atcollab/at/pull/524
• Update at.beam by @lfarv in https://github.com/atcollab/at/pull/531
• Use the ct coordinate in the variable multipole pass method by @carmignani in https://github.com/atcollab/at/pull/532
• Update quantum diffusion pass methods by @lfarv in https://github.com/atcollab/at/pull/534
• at.beam improvement by @lfarv in https://github.com/atcollab/at/pull/537
• Collective unit tests by @swhite2401 in https://github.com/atcollab/at/pull/539
• New plot_sigma() plotting function by @lfarv in https://github.com/atcollab/at/pull/541
• Stub files for C extensions by @lfarv in https://github.com/atcollab/at/pull/542
• relax chromaticity test for numpy 1.24 by @lfarv in https://github.com/atcollab/at/pull/545
• Improvement of the "refpts" argument by @lfarv in https://github.com/atcollab/at/pull/547
• Momentum offset for 6d orbit by @swhite2401 in https://github.com/atcollab/at/pull/540
• do not split elements with IdTablePass method by @oscarxblanco in https://github.com/atcollab/at/pull/563
• Frequency Analysis by @oscarxblanco in https://github.com/atcollab/at/pull/556
• IdTablePass by @oscarxblanco in https://github.com/atcollab/at/pull/558
• Axis definitions by @lfarv in https://github.com/atcollab/at/pull/566
• Develop lattice by @lfarv in https://github.com/atcollab/at/pull/565
• Improve the import order by @lfarv in https://github.com/atcollab/at/pull/576
• zero length elements in lifetime calculation by @swhite2401 in https://github.com/atcollab/at/pull/577
• Lattice operators by @swhite2401 in https://github.com/atcollab/at/pull/573
• ringparam always returns an emittance by @swhite2401 in https://github.com/atcollab/at/pull/583
• Acceptance shift zero + docs by @swhite2401 in https://github.com/atcollab/at/pull/588
• Restore the standard behaviour of reversed(Lattice) by @lfarv in https://github.com/atcollab/at/pull/589
• Energy loss relative tolerance by @swhite2401 in https://github.com/atcollab/at/pull/596
• Relaxed passmethod coherence tests when loading files by @lfarv in https://github.com/atcollab/at/pull/600
• Documentation for Collective Effects by @lcarver in https://github.com/atcollab/at/pull/599
• regex option by @swhite2401 in https://github.com/atcollab/at/pull/601

Incompatibilities

• None expected

New Contributors

• @oscarxblanco made their first contribution in https://github.com/atcollab/at/pull/563
• @pcsch made their first contribution in https://github.com/atcollab/at/pull/587

Full Changelog: https://github.com/atcollab/at/compare/pyat-0.3.0...pyat-0.4.0

[lfarv]

Please have a look to the updated developer notes (for the release procedure) and to the release notes. All comments are welcome.

[lfarv]

It would be nice to include #612, #613, #615 and #617 in the release: these are small changes. Any progress on that ?

[lfarv]

@swhite2401, @simoneliuzzo: any comment on the proposed release? do we postpone #613 and #615 to the next one or do you want to include them?

[swhite2401]

@lfarv for me it is fine, at least #615 should go in. @simoneliuzzo is this ok for you? If you don't like the changes related to phase matching I can remove this part and keep it for the next one, but bug fixes should definitely go in.

[swhite2401]

for #613 let's keep it for later, there is this phase issue that needs to be understood

[lfarv]

@swhite2401: Is this OK now to release 0.4.0 ? I included #613 and #615 in the release notes. If you agree, can you approve this PR?