simtools-docs-produce-production-summary

Produce a markdown file with production version descriptions.

Reads info.yml files from the simulation-models productions directory and writes a markdown table of production model versions and their short descriptions. Select either a checked-out repository with --simulation_models_path or a local Git repository with --simulation_models_git_path and --simulation_models_git_revision.

Command line arguments

simulation_models_path (Path)

Path to a checked-out simulation-models repository. Use this or the Git options.

simulation_models_git_path (Path)

Path to a local normal, bare, or mirror Git simulation-model repository.

simulation_models_git_revision (str)

Git tag, ref, or commit to read. Defaults to the dependency catalog revision.

output_path (Path)

Directory for the output file.

output_file (str)

Output markdown file name.

Example

simtools-docs-produce-production-summary \\
    --simulation_models_path ../simulation-models \\
    --output_path simtools-output/reports/productions \\
    --output_file production_version_descriptions.md

simtools-docs-produce-production-summary \\
    --simulation_models_git_path ../simulation-models.git \\
    --simulation_models_git_revision HEAD \\
    --output_path simtools-output/reports/productions \\
    --output_file production_version_descriptions.md

Command line arguments

options

–help

show this help message and exit

output

–output_file

Output data file.

–output_file_format

file format of output data

Default: ecsv.

–skip_output_validation

skip output data validation against schema

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.

application

–show_options

Print available values for a supported option and exit.

Example

Summarize simulation-model productions

Read a simulation-model repository and generate a report of its available production configurations.

Application: simtools-docs-produce-production-summary

Integration test: docs_produce_production_summary_run.yml

Command

simtools-docs-produce-production-summary --config tests/integration_tests/config/docs_produce_production_summary_run.yml

Configuration

output_path: simtools-output/reports/productions/
output_file: production_version_descriptions.md