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)

Read and manage model parameter data for report generation.

get_all_parameter_descriptions()

Get descriptions for all model parameters.

Returns:

tuple: A tuple containing two dictionaries:

• parameter_description: Maps parameter names to their descriptions.

• short_description: Maps parameter names to their short descriptions.

• inst_class: Maps parameter names to their respective class.

get_array_element_parameter_data(telescope_model, collection='telescopes')

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

Currently only configured for telescope.

Parameters:

telescope_modelTelescopeModel

The telescope model instance.

Returns:

list: A list of lists containing parameter names, values with units,

descriptions, and short descriptions.

produce_array_element_report()

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()

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()

Produce a markdown report of all observatory parameters for a given site.

docs_auto_report_generator

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

class reporting.docs_auto_report_generator.ReportGenerator(db_config, args, output_path)

Automate report generation.

auto_generate_array_element_reports()

Generate all reports based on which –all_* flag is passed.

auto_generate_observatory_reports()

Generate all observatory reports based on which –all_* flags are passed.

auto_generate_parameter_reports()

Generate parameter reports for all telescope-site combinations.