Skip to content

WIP AC ORM Report class#322

Draft
vellosok75 wants to merge 6 commits intomasterfrom
acorm-script
Draft

WIP AC ORM Report class#322
vellosok75 wants to merge 6 commits intomasterfrom
acorm-script

Conversation

@vellosok75
Copy link
Copy Markdown
Contributor

  • Report class similar to that of LOCO's
  • Part of the efforts of moving the AC ORM measurement to a script
  • The script will carry out the measurement and launch the analysis and the report.
  • report will contain basic info about the measurement as well as the key analysis we use to access the measurement quality: scale factors, correlation residue and particular columns comparison

Usage example:

from a preexisting meas_orm = MeasACORM() object with measurement data loaded, you can generate the analysis and the report with

from apsuite.commisslib.meas_ac_orm import ORMReport
report = ORMReport()
report.create_report(meas_orm=meas_orm, folder='reports/')

which will save the png files and the report pdf at the reports directory.

Many adjustments are yet missing. Work in progress

- Report class similar to that of LOCO's
- Part of the efforts of moving the AC ORM measurement to a script
- The script will carry out the measurement and launch the analysis and the report.
- report will contain basic info about tthe measurement as well as the key analysis we use to access the measurement quality: scale factors,  correlation residue and particular columns comparison
- to a new `resources` directory in apsuite's root
- introduces a `show_fig` arg to all the plotting functions
- this allows to set it to False, supressing the `fig.show()` command when running analysis
- useful for using these functions when runnning the new report class, where we want to generate the figures and save them, but don't want to display the figures
- propagates changes from last commit to the report class: `show_fig=False`
- also makes sure all figures are closed after opened (if running on a Jupyter notebook fiugres can still be shown)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant