Configuration options

When using the programmatic interface of this package, the configuration options used by the different parts of the sending operation are given as objects. For details see:

• ReceiverConfig, ScanProviderConfig, TelescopeManagerConfig, UVWEngineConfig and SdpConfigDbConfig for the top-level configuration.

• aggregation.AggregationConfig for the aggregation configuration.

• receivers.Config and Spead2ReceptionConfig for the receiver configuration.

• consumers.Config, MSWriterConfig and PlasmaWriterConfig for the consumer configuration.

From nested dictionaries

When using the command-line interface, options can be specified either in a YAML configuration file, or individually via the vis-receiver -o option. In both cases options live within a group or category, and have a name and a value, and thus the overall configuration can be specified as a top-level dictionary with group names as keys, and group dictionaries as values. To preserve backwards compatibility, the programmatic entry point still accepts this dictionary-based configuration approach too.

These options are used to populate a ReceiverConfig object as follows:

• Within each group, the key names are directly mapped to the corresponding configuration object member.

• The telescope_manager group is used to populate the options in the TelescopeManagerConfig object under realtime.receive.modules.receiver.ReceiverConfig.tm.

• The scan_provider group is used to populate the options in the ScanProviderConfig object under realtime.receive.modules.receiver.ReceiverConfig.scan_provider.

• The uvw group is used to populate the options in the UVWEngineConfig object under realtime.receive.modules.receiver.ReceiverConfig.uvw_engine.

• The sdp_config_db group is used to populate the options in the SdpConfigDbConfig object under realtime.receive.modules.receiver.ReceiverConfig.sdp_config_db.

• The aggregation group is used to populate the options in the aggregation.AggregationConfig object under realtime.receive.modules.receiver.ReceiverConfig.aggregation.

• The reception group is used to populate the options in the receivers.Config (or subclass) object under realtime.receive.modules.receiver.ReceiverConfig.reception.

• The consumer group is used to populate the options in the consumers.Config (or subclass) object under realtime.receive.modules.receiver.ReceiverConfig.consumer.

Apart from these rules, the following backwards-compatible names have been kept:

• reception.command_template -> consumer.command_template.`

• reception.consumer -> consumer.name.

• reception.datamodel -> scan_provider.measurement_set.

• reception.datamodel -> telescope_model.measurement_set.

• reception.disable_astropy_iers_autodownload -> uvw.disable_astropy_iers_autodownload.

• reception.execution_block_id -> scan_provider.execution_block_id.

• reception.execution_block_id -> telescope_model.execution_block_id.

• reception.layout -> telescope_model.antenna_layout.

• reception.max_payloads -> consumer.max_payloads_per_ms.

• reception.outputfilename -> consumer.output_filename.

• reception.payloads_in_flight -> consumer.payloads_in_flight.

• reception.plasma_path -> consumer.plasma_path.

• reception.receiver_port_start -> reception.port_start.

• reception.sched_block -> scan_provider.assign_resources_command.

• reception.schedblock -> telescope_model.schedblock.

• reception.sdp_config_backend -> sdp_config_db.backend.

• reception.sdp_config_host -> sdp_config_db.host.

• reception.sdp_config_port -> sdp_config_db.port.

• reception.timestamp_output -> consumer.timestamp_output.`

• reception.transport_proto -> reception.transport_protocol.

• reception.uvw_engine -> uvw.engine.