Reference API

Command-line tools

usage: iact-estimator [-h] [--version] [--performance PERFORMANCE]
                      {config,run} ...

Positional Arguments

command

Possible choices: config, run

Named Arguments

--version

Default: False

--performance

Custom performance data.

Default: ''

Get the default config file

usage: iact-estimator config [-h] [--to TO]

Named Arguments

--to

Where to save the configuration file (default: current working directory).

Run the estimation process

usage: iact-estimator run [-h] --config CONFIG [--source-name SOURCE_NAME]
                          [--output-path OUTPUT_PATH]
                          [--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
                          [--overwrite]

Named Arguments

--config

Path to configuration file.

--source-name

Name of the source to estimate.

Default: 'test_source'

--output-path

Path where output will be saved (defaults to current working directory)

--log-level

Possible choices: DEBUG, INFO, WARNING, ERROR, CRITICAL

Logging level.

Default: INFO

--overwrite

Overwrite any generated output.

Default: False

Package resources

The package comes shipped with a set of package resources which are available after installation,

  • a configuration file config.yml, which can be obtained with the Get the default config file command

  • a ~astropy.table.QTable containing the low zenith (0 to 30 degrees) performance (from iact_estimator import LOW_ZENITH_PERFORMANCE)

  • a ~astropy.table.QTable zenith (0 to 30 degrees) performance (from iact_estimator import MID_ZENITH_PERFORMANCE)

API description

This section contains auto-generated API reference documentation [1].