metpyrad.Hidex300.summarize_readings

Hidex300.summarize_readings(save=False, folder_path=None)

Summarizes the readings by printing a message or saving it to a text file.

Parameters:

• save (bool) – If True, saves the summary to a text file. Else, prints the summary. Default is False.

• folder_path (str) – Path to the folder where the summary file will be saved. Required if save is True.

Examples

>>> processor = Hidex300('Lu-177', 2023, 11)
>>> processor.summarize_readings()
Measurements of Lu-177 on November 2023

>>> processor = Hidex300('Lu-177', 2023, 11)
>>> processor.parse_readings(folder_path='/path/to/folder')
Found 2 CSV files in folder /path/to/folder
>>> processor.summarize_readings()
Measurements of Lu-177 on November 2023
Summary
Number of cycles: 2
Repetitions per cycle: 2
Time per repetition: 100 s
Total number of measurements: 4
Total measurement time: 400 s
Cycles summary
   Cycle  Repetitions  Real time (s)                Date
0      1            2            100 2023-11-30 08:44:20
1      2            2            100 2023-12-01 12:46:16

>>> processor = Hidex300('Lu-177', 2023, 11)
>>> processor.summarize_readings(save=True, folder_path='/path/to/folder/')
Summary saved to /path/to/folder/summary.txt