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, telescope_model, output_path)

Read and manage model parameter data.

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 for a given array element.

Currently only configures 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.

produce_model_parameter_reports()

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