TODO.md

Pymusr TODO

short term

• plot_asymmetry and plot_counts into one method?
• Change plot methods to use OOP matplotlib instead of pyplot
• Add goodness of fit (RMSE?, Chi-squared?)
• Change label for asymmetry plot
• Store standard groupings in files (pickle or JSON?)

long term

• Write documentation (readthedocs?)
• Add errors to counts and asymmetry (maybe this will improve fit)
• Get num_events from .v1190.root?
  • Maybe get num_events from .mac file?
    • Change data path to directory containing .mac files
• Check minimum version of python in setup.cfg (minimum is version 3.10 because type hints)
• Add GUI

Done

• Package project
• Create "pair" object
  • Add method to MuonInstrument to create "pair" from specified detector groups
  • Add method to estimate alpha for a "pair" object
  • Add method to calculate and plot asymmetry for a "pair" object
• Make plot methods more flexible
  • Add parameter to change initial point of iteration
  • Add parameter to change bounds for parameters
• Improve models.py
  • Use one class for all functions instead of a class for each function
• Tidy up .group_data method
• Add method to plot any histogram from .v1190.root file
  • Deal with all 3 cases - plain histogram, 2D histogram, categorical histogram
  • Return numpy arrays of data for further analysis if required
• Add option to change number of bins on histograms
• Add ability to plot histograms from the musrSim root file