simtools-inspect-file#

Inspect simulation-related files and prints out a structured report of their contents.

For known simulation products, the application can append specialized inspection sections on top of the generic file-structure report.

Command line arguments

input_file (str, required): Simulation-related file to inspect.
max_entries (int, optional): Maximum number of entries or preview lines to print. Use 0 for no limit.
show_entry (str, optional): Print the content of one HDF5 root dataset instead of the file structure report.

Command line arguments#

–help

show this help message and exit

–input_file

Simulation-related file to inspect.

Required.

–max_entries

Maximum number of entries or preview lines to print; use 0 for no limit.

Default: 50.

–show_entry

Print one HDF5 root dataset, for example SIMULATION_METADATA or SHOWERS.

Display the structure and first entries of a generated North-array sim_telarray configuration file.

Application: simtools-inspect-file

Integration test: inspect_file_cfg.yml

Command

simtools-inspect-file --config tests/integration_tests/config/inspect_file_cfg.yml

Configuration

input_file: ${generated:sim_telarray_configurations/7.0.0/CTAO-North-CTAO-North-Alpha.cfg}
max_entries: 5

Display datasets and metadata stored in a reduced gamma-ray event-data HDF5 file.

Application: simtools-inspect-file

Integration test: inspect_file_hdf5.yml

Command

simtools-inspect-file --config tests/integration_tests/config/inspect_file_hdf5.yml

Configuration

input_file: ${generated:gamma_diffuse_run000010_za20deg_azm000deg_North_CTAO-North-Alpha_7.0.0_test.reduced_event_data.hdf5}

Display run headers, events, and metadata from a proton sim_telarray event file.

Application: simtools-inspect-file

Integration test: inspect_file_simtel.yml

Command

simtools-inspect-file --config tests/integration_tests/config/inspect_file_simtel.yml

Configuration

input_file: ${generated:proton_run000001_za20deg_azm180deg_North_CTAO-North-Alpha_7.0.0_test.simtel.zst}
max_entries: 5