Reporting#

The reporting modules read model parameter values and descriptions from the database and write to a report.

docs_read_parameters#

Class to read and manage relevant model parameters for a given telescope model.

class reporting.docs_read_parameters.ReadParameters(db_config, args, output_path)[source]#

Read and manage model parameter data for report generation.

get_all_parameter_descriptions(collection='telescopes')[source]#

Get descriptions for all model parameters.

Returns:

dict: Nested dictionaries with first key as the parameter name and the following dictionary as the value: - key: description, value: description of the parameter. - key: short_description, value: short description of the parameter. - key: inst_class, value: class, for eg. Structure, Camera, etc.

get_array_element_parameter_data(telescope_model, collection='telescopes')[source]#

Get model parameter data and descriptions for a given array element.

Currently only configured for telescope.

Parameters:

Returns:

list: A list of lists containing parameter names, values with units,: descriptions, and short descriptions.

get_calibration_data(all_parameter_data, array_element)[source]#: Get calibration data and descriptions for a given array element.

get_simulation_configuration_data()[source]#: Get data and descriptions for simulation configuration parameters.

produce_array_element_report()[source]#

Produce a markdown report of all model parameters per array element.

Outputs one markdown report of a given array element listing parameter values, versions, and descriptions.

produce_model_parameter_reports(collection='telescopes')[source]#

Produce a markdown report per parameter for a given array element.

Outputs one markdown report per model parameter of a given array element comparing values across model versions.

produce_observatory_report()[source]#: Produce a markdown report of all observatory parameters for a given site.

produce_simulation_configuration_report()[source]#: Write simulation configuration report.

Class to automate generation of all reports according to command line inputs.

class reporting.docs_auto_report_generator.ReportGenerator(db_config, args, output_path)[source]#

Automate report generation.

auto_generate_array_element_reports()[source]#: Generate all reports based on which –all_* flag is passed.

auto_generate_observatory_reports()[source]#: Generate all observatory reports based on which –all_* flags are passed.

auto_generate_parameter_reports()[source]#: Generate parameter reports for all telescope-site combinations.