MatLabTools

Repository storing some common material written in MatLab

Repo Structure

There is no rigid structure in the repo. For the sake of good fractioning of the code, it would be great to have functions grouped by areas of applicability, resulting in not too many files in a single folder.

For the time being:

folder name	description
educational	scripts of general interest showing quantities relevant to CNAO (e.g. bar of charge, beam quantities vs energy, etc...)
general	scripts of general interest (e.g. math, MatLab environment, etc...)
MADX-optics	scripts for plotting optics computed by MADX
MADX-tracking	scripts for plotting tracking data computed by MADX
measurement_analysis	scripts for performing some standard analysis or inspecting data
operations	tools for manipulating operational parameters (e.g. to convert them to MADX input)
optics	tools for manipulating/computing optics quantities
RP	tools for parsing/writing log files by RP monitors

Naming Conventions

No particularly strict rules, apart from:

• using CamelCase style (proposed);
• Plot* is a function that simply adds a plot to a subplot window, whereas a Show* function creates a brand new window with a collection of plots in a specific manner;

References

• Official MathWorks docs about function help, i.e. the possibility to type in comments that are displayed by the help of the native MatLab editor;
• dirty way to implement optional input parameters to functions;
• Official MathWorks docs about input parser (advanced);

Startup

• MatLab automatically runs the file named startup.m if it is saved in a known folder in the path, e.g. C:/Users/enrico.felcini/Documents/MATLAB. This file can be used to set physical constants (e.g. speed of light), standard plot parameters and run specific scripts (e.g. pathdef.m that contains the path definition of the user's folders).