Release `v0.6.2` - Githubissues

desy-ml / cheetah

Fast and differentiable particle accelerator optics simulation for reinforcement learning and optimisation applications.

https://cheetah-accelerator.readthedocs.io

GNU General Public License v3.0

27 stars 12 forks source link

Release `v0.6.2` #94

Closed jank324 closed 4 months ago

jank324 commented 8 months ago

ToDos for release 0.6.2

[x] Add charge to the ParameterBeam and ParticleBeam classes (see #86)
[x] Add opt-in speed optimisations (see #88)
[x] Fix the transfer maps in Drift and Dipole; Add R56 in horizontal and vertical correctors modelling (see #90)
[ ] ~~Refactor beam.empty (see #93)~~
[x] Fix CPU/GPU mismatch (see #97)
[x] NX Tables import (#96)

cr-xu commented 7 months ago

Should we try to stick with semantic versioning (from now on)? These features seem to be deserving a MINOR version.

Or that's something to consider after v1.0.0 :)

jank324 commented 7 months ago

I agree, but I think this is something to consider after v1.0.0 (right now the leading "v0." is just meant to indicate a pre-release version like it does in Gymnasium). But the important question this raises is: When do we move to v1.0.0?

jank324 commented 7 months ago

So there is one task left here ... nice! I think #100 is something for a v0.6.3 or v0.7.0 depending on how severely it introduces breaking changes if and when we do it. And then we can think about v1.0.0.

jank324 commented 6 months ago

I think v0.6.2 should become the paper reference release.

We can probably also skip the empty beam feature for this release.

Nevertheless, we should be sure that this release runs well with the tutorial before publishing it.

jank324 commented 5 months ago

Wait for #117 to be merged

jank324 commented 5 months ago

I think we should ship this release ASAP.

jank324 commented 5 months ago

[x] Run tests on GPU before release

jank324 commented 4 months ago

... and published! 🚀