simtools-docs-produce-reports#

Produce markdown reports for the simulation model.

Report types: array_element (per telescope), calibration (calibration devices), model_parameter (model parameters per telescope) and simulation_configuration (simulation software configuration parameters).

Produces markdown reports for the simulation model. The report type is selected with --report:

  • array_element: parameters of one telescope (--site, --telescope, --model_version), or all telescopes, sites or model versions (--all_telescopes, --all_sites, --all_model_versions); --observatory adds observatory reports.

  • calibration: calibration devices (--model_version or --all_model_versions).

  • model_parameter: model parameters per telescope (--site, --telescope), or all telescopes and sites (--all_telescopes, --all_sites).

  • simulation_configuration: configuration parameters of a simulation software (--simulation_software, --model_version or --all_model_versions).

Command line arguments

report (str, required)

Type of report: array_element, calibration, model_parameter or simulation_configuration.

model_version (str, optional)

Model version.

all_model_versions (activation mode, optional)

Produce reports for all model versions.

all_telescopes (activation mode, optional)

Produce reports for all telescopes.

all_sites (activation mode, optional)

Produce reports for all sites.

observatory (activation mode, optional)

Produce array_element reports for an observatory at a given site.

simulation_software (str, optional)

Simulation software workflow (simulation_configuration reports).

Example

Produce the parameter report of one telescope:

simtools-docs-produce-reports --report array_element --site North --telescope LSTN-01 \\
--model_version 6.0.2

Produce calibration-device reports for all model versions:

simtools-docs-produce-reports --report calibration --all_model_versions

Command line arguments#

options#

–help

show this help message and exit

–report

Type of report to produce.

Required. Choices: array_element, calibration, model_parameter, simulation_configuration.

–all_telescopes

Produce reports for all telescopes.

–all_sites

Produce reports for all sites.

–observatory

Produce array_element reports for an observatory at a given site.

application#

–all_model_versions

Produce reports for all model versions.

–show_options

Print available values for a supported option and exit.

simulation software#

–simulation_software

Simulation software workflow.

Default: corsika_sim_telarray. Choices: corsika, sim_telarray, corsika_sim_telarray.

simulation model#

–model_version

Simulation production model version(s). Use –show_options model_version.

–overwrite_model_parameters

JSON string with model parameters to overwrite

–site

Observatory site (e.g., North, South). Use –show_options site.

–telescope

telescope model name (e.g., LSTN-01, SSTS-design, …)

model repository#

–simulation_models_path

Path containing the simulation-model repository to read.

–simulation_models_git_path

Path to a local normal, bare, or mirror Git repository containing simulation models.

–simulation_models_git_revision

Git tag, ref, or commit to read from the simulation-model repository.

Examples#

Produce an LST model-parameter report#

Generate a user-facing report of simulation-model parameters for the North-site LSTN-01 telescope.

Application: simtools-docs-produce-reports

Integration test: docs_produce_reports_array_element_run.yml

Command

simtools-docs-produce-reports --config tests/integration_tests/config/docs_produce_reports_array_element_run.yml

Configuration

report: array_element
model_version: 6.0.2
output_path: simtools-output/reports/productions/
site: North
telescope: LSTN-01

Produce calibration-device reports#

Generate documentation tables and pages for calibration devices defined in the simulation model.

Application: simtools-docs-produce-reports

Integration test: docs_produce_reports_calibration_run.yml

Command

simtools-docs-produce-reports --config tests/integration_tests/config/docs_produce_reports_calibration_run.yml

Configuration

report: calibration
model_version: 6.0.2
output_path: simtools-output/reports/productions/

Produce telescope model-parameter reports#

Generate documentation for the model parameters associated with the North-site LSTN-01 telescope.

Application: simtools-docs-produce-reports

Integration test: docs_produce_reports_model_parameter_run.yml

Command

simtools-docs-produce-reports --config tests/integration_tests/config/docs_produce_reports_model_parameter_run.yml

Configuration

report: model_parameter
output_path: simtools-output/reports/
site: North
telescope: LSTN-01

Document the CORSIKA configuration#

Generate a reference report for the CORSIKA configuration parameters supported by simtools.

Application: simtools-docs-produce-reports

Integration test: docs_produce_reports_simulation_configuration_run.yml

Command

simtools-docs-produce-reports --config tests/integration_tests/config/docs_produce_reports_simulation_configuration_run.yml

Configuration

report: simulation_configuration
model_version: 6.0.2
output_path: simtools-output/reports/productions/
simulation_software: corsika