Matlab release 2.5 - Githubissues

lfarv commented 8 months ago

A new Matlab release including more that 1 year of updates.

There is no code change in this PR, only documentation and configuration changes.

A new tag and release will be published as soon as this PR is approved. The distribution on Matlab Central will follow immediately.

lnadolski commented 8 months ago

As described in https://github.com/atcollab/at/wiki

1/ Contents can be generated using atupdateContents 2/ html documentation can once again be generated using atm2html (part of MML) or to be installed from https://github.com/gllmflndn/m2html graph dependence using https://graphviz.org/

lnadolski commented 8 months ago

Dear @lfarv,

All Contents are generated using atupdateContents. Do you want to include them in the release or should they be added during the installation of AT following the wiki page?

lnadolski commented 8 months ago

In the release not, could add the CorrectorPass bug fix.

Misalignments and aperture are now considered

lfarv commented 8 months ago

@lnadolski

In the release not, could add the CorrectorPass bug fix.

You are right. I'll do that manually. Most of release notes is generated automatically, using the title of each pull request. Unfortunately, the CorrectorPass bug fix was not mentioned in the title… This shows how the PR titles must be very carefully chosen, and why mixing several things in a single PR may lead to problems.

lfarv commented 8 months ago

@lnadolski: I ignored the existence of the wiki (my fault, it's indeed referred in the README), and the instructions are somewhat different from the "official" ones. This raises a few problems:

using atupdateContents breaks the version number by rewriting the 1st two lines of atmat/Contents.m. According to the developer notes this file (its 1st 2 lines, in fact) is handled by the setversion command. atupdateContents should be modified to preserve these 1st 2 lines.
I don't think it's up to the user to generate the documentation: it should be ready and available in each release. I don't think that atm2html is the solution to the Matlab documentation problem, but if it works, why not keep it… In this case, the generation of documentation should be added to the developer notes, and removed from the installation process. And we should find a way to host the html doc somewhere on the web site. A local version is difficult to handle for a standard installation from Matlab Central because the installation location depends on the platform, version, etc. For instance, for me (macOS), atroot='/Users/laurent/Library/Application Support/MathWorks/MATLAB Add-Ons/Toolboxes/Accelerator Toolbox/atmat'.

swhite2401 commented 8 months ago

Shall we make a new python release at the same time?

lfarv commented 8 months ago

Shall we make a new python release at the same time?

PyAT 0.4.0 is almost 5 months old. Why not… But exact synchro is not necessary.

lfarv commented 8 months ago

Added the CorrectorPass bug fix in the release notes.

lfarv commented 8 months ago

@lnadolski : I ran atupdateContents and committed the created Contents.m files, so that a user does not need to run it. But I see some changes to be done in the future:

is the double recursion needed? Contents files are recursively generated in all subfolders (as normally in Matlab), but in addition each of these files describes recursively everything below. This ends up with many repetitions. While normally a Matlab contents describes only its containing folder.
One should skip the functions declared private or obsolete. Unless we move them in specific folders

I think this should be part of another dedicated PR for documentation. For the moment, all contents files are there, that should be enough for a release. Do you agree with the present state?

swhite2401 commented 8 months ago

PyAT 0.4.0 is almost 5 months old. Why not… But exact synchro is not necessary.

Since there has been quite a lot a new features added this would probably be a good idea, or at least before Christmas

lfarv commented 8 months ago

I'd like to wait for the upgrade of the C constants (#691 ) before releasing the version. Otherwise, any comment on this release?

lfarv commented 7 months ago

This release is ready. Please comment or approve.

Release notes

lfarv commented 7 months ago

cavpts missing from atSetRingParameters atGetRingParameters

Can you give more details on your problem: which platform, lattice example ? I can't reproduce the problem, for me atGetRingProperties(ring, 'cavpts') returns the cavities with the lowest frequency, as expected.

lfarv commented 7 months ago

@simoneliuzzo : Sorry. I missed your message, but I have now all the info, thanks.

lfarv commented 7 months ago

cavpts missing from atSetRingParameters atGetRingParameters

Fixed in #701

lfarv commented 7 months ago

Hello @simoneliuzzo. The bug you reported in now corrected. Unless you have other remarks, can you approve again the release?

atcollab / at

Matlab release 2.5 #689