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

New features

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

Incompatibilities

• None expected

New Contributors

• @oscarxblanco made their first contribution in do not split elements with IdTablePass method #563
• @pcsch made their first contribution in Fixes bug producing infrequent NaN from calcnaff #587

Full Changelog: 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 ?

[MJGaughran]

'splitted in' -> 'split into'

Are you suggesting having two top-level titles ('Bug fixes' and 'New features') only, or keeping What's Changed?

[lfarv]

I thought that any modification would fall in either "bug fix" or "new feature", but one could think of other sections.
Any idea?

[MJGaughran]

I was thinking 'split into' -> 'replaced with', to make it clear that the "What's Changed" heading is removed completely.

[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?

[swhite2401]

All ok for me!