simtools-get-array-layout#

Get array layouts from a simulation-model repository.

simtools.applications.get_array_layout.run(app_context)[source]#: Run array-layout retrieval using an initialized application context.

To get the list of pre-defined array layouts, use --list_available_layouts.

To get the list of array elements for a given layout, use --array_layout_name.

To get the positions for a set of array elements, use --array_element_list. Listing of array elements follows this logic:

explicit listing: e.g., -array_element_list MSTN-01, MSTN05
listing of types: e.g, -array_element_list MSTN plots all telescopes of type MSTN.

Command line arguments

list_available_layoutsbool, optional: List available layouts in the repository.
include_calibration_array_elementsbool, optional: Include calibration array elements in output table (default: only telescopes).
array_layout_namestr: Name of the layout array (e.g., test_layout, alpha, 4mst, etc.).
array_element_listlist: List of array elements (e.g., telescopes) to plot (e.g., LSTN-01 LSTN-02 MSTN).
coordinate_systemstr, optional: Coordinate system for the array layout (ground or utm).
output_filestr, optional: Name of the output file to be saved as astropy table (ecsv file)

Examples

List pre-defined array layouts.

simtools-get-array-layout --site North --model_version "6.0.0" --list_available_layouts

Retrieve telescope positions for array layout ‘test_layout’ from the model repository.

simtools-get-array-layout --site North --model_version "6.0.0"
    --array_layout_name test_layout

Retrieve telescope positions from the model repository (utm coordinate system) and write to an ecsv files

simtools-get-array-layout --site North --model_version "6.0.0"
  --array_element_list LSTN-01 LSTN-02 MSTN
  --coordinate_system utm
  --output_file telescope_positions-test_layout.ecsv

Retrieve array-element positions including calibration elements.

simtools-get-array-layout --site South --model_version "6.0.2"
    --array_element_list LSTS ILLS
    --include_calibration_array_elements
    --output_file array_layout_south_ground_with_calibration.ecsv

Command line arguments#

options#

–help

show this help message and exit

–list_available_layouts

List available layouts in the simulation-model source.

–include_calibration_array_elements

Include calibration array elements in output table.

–coordinate_system

Coordinate system for the array layout.

Default: ground. Choices: ground, utm.

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.
–array_layout_name: Array layout name(s) (e.g., CTAO-North-Alpha, LSTN-01). Telescope names are assumed as single-telescope layouts. Use –show_options array_layout_name.
–array_element_list: list of array elements (e.g., LSTN-01, LSTN-02, MSTN).

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.

Examples#

Export a South array from telescope classes#

Build a South-site ground-coordinate layout containing the selected LST, MST, and SST classes.

Application: simtools-get-array-layout

Integration test: get_array_layout_layout_list.yml

Command

simtools-get-array-layout --config tests/integration_tests/config/get_array_layout_layout_list.yml

Configuration

array_element_list:
- LSTS
- MSTS
- SSTS
coordinate_system: ground
model_version: 6.0.2
output_file: array_layout_south_ground_from_list.ecsv
output_path: simtools-output
site: South

Export a named North array layout#

Resolve the version-appropriate North Alpha layout and export its array-element positions.

Application: simtools-get-array-layout

Integration test: get_array_layout_layout_name.yml

Command

simtools-get-array-layout --config tests/integration_tests/config/get_array_layout_layout_name.yml

Configuration

array_layout_name:
  by_version:
    <7.0.0: alpha
    '>=7.0.0': CTAO-North-Alpha
model_version: 6.0.2
site: North

Export a layout with calibration devices#

Build a South-site ground-coordinate layout containing LSTs and illuminators, including calibration elements.

Application: simtools-get-array-layout

Integration test: get_array_layout_layout_with_calibration_flag.yml

Command

simtools-get-array-layout --config tests/integration_tests/config/get_array_layout_layout_with_calibration_flag.yml

Configuration

array_element_list:
- LSTS
- ILLS
include_calibration_array_elements: true
coordinate_system: ground
model_version: 7.0.0
output_file: array_layout_south_ground_with_calibration.ecsv
output_path: simtools-output
site: South

List available North array layouts#

Query the simulation-model repository for the array layouts available at the North site.

Application: simtools-get-array-layout

Integration test: get_array_layout_list_arrays.yml

Command

simtools-get-array-layout --config tests/integration_tests/config/get_array_layout_list_arrays.yml

Configuration

list_available_layouts: true
model_version: 6.0.2
site: North