Low TMC assign resources 4.0

Example JSON.

{
    "interface": "https://schema.skao.int/ska-low-tmc-assignresources/4.0",
    "transaction_id": "txn-....-00001",
    "subarray_id": 1,
    "mccs": {
        "interface": "https://schema.skao.int/ska-low-mccs-controller-allocate/3.0",
        "subarray_beams": [{
            "subarray_beam_id": 1,
            "apertures": [{
                "station_id": 1,
                "aperture_id": "AP001.01"
            }, {
                "station_id": 1,
                "aperture_id": "AP001.02"
            }, {
                "station_id": 2,
                "aperture_id": "AP002.01"
            }, {
                "station_id": 2,
                "aperture_id": "AP002.02"
            }],
            "number_of_channels": 8
        }]
    },
    "csp": {
        "pss": {
            "pss_beam_ids": [1, 2, 3]
        },
        "pst": {
            "pst_beam_ids": [1]
        }
    },
    "sdp": {
        "interface": "https://schema.skao.int/ska-sdp-assignres/0.4",
        "resources": {
            "receptors": ["C4", "C57", "C108", "C165", "C193", "C200", "S8-1", "S8-2", "S9-1", "S9-5", "S10-1", "S10-6", "S16-3", "S16-4", "S16-6"]
        },
        "execution_block": {
            "eb_id": "eb-test-20220916-00000",
            "context": {},
            "max_length": 3600.0,
            "beams": [{
                "beam_id": "vis0",
                "function": "visibilities"
            }],
            "scan_types": [{
                "scan_type_id": ".default",
                "beams": {
                    "vis0": {
                        "channels_id": "vis_channels",
                        "polarisations_id": "all"
                    }
                }
            }, {
                "scan_type_id": "target:a",
                "derive_from": ".default",
                "beams": {
                    "vis0": {
                        "field_id": "field_a"
                    }
                }
            }, {
                "scan_type_id": "calibration:b",
                "derive_from": ".default",
                "beams": {
                    "vis0": {
                        "field_id": "field_b"
                    }
                }
            }],
            "channels": [{
                "channels_id": "vis_channels",
                "spectral_windows": [{
                    "spectral_window_id": "fsp_1_channels",
                    "count": 4,
                    "start": 0,
                    "stride": 2,
                    "freq_min": 350000000.0,
                    "freq_max": 368000000.0,
                    "link_map": [
                        [0, 0],
                        [200, 1],
                        [744, 2],
                        [944, 3]
                    ]
                }]
            }],
            "polarisations": [{
                "polarisations_id": "all",
                "corr_type": ["XX", "XY", "YX", "YY"]
            }],
            "fields": [{
                "field_id": "field_a",
                "phase_dir": {
                    "ra": [123.0],
                    "dec": [-60.0],
                    "reference_time": "...",
                    "reference_frame": "ICRF3"
                },
                "pointing_fqdn": "..."
            }, {
                "field_id": "field_b",
                "phase_dir": {
                    "ra": [123.0],
                    "dec": [-60.0],
                    "reference_time": "...",
                    "reference_frame": "ICRF3"
                },
                "pointing_fqdn": "..."
            }]
        },
        "processing_blocks": [{
            "pb_id": "pb-test-20220916-00000",
            "script": {
                "kind": "realtime",
                "name": "test-receive-addresses",
                "version": "0.7.1"
            },
            "sbi_ids": ["sbi-mvp01-20210623-00000"],
            "parameters": {}
        }]
    }
}

https://schema.skao.int/ska-low-tmc-assignresources/4.0

type

object

properties

  • interface

URI of JSON schema applicable to this JSON payload.

type

string

  • transaction_id

A transaction id specific to the command

type

string

  • subarray_id

ID of sub-array targeted by this resource allocation request

type

integer

  • mccs

Low MCCS assign resources 3.0

MCCS specification for resource allocation.

type

object

properties

  • interface

URI of JSON schema applicable to this JSON payload.

type

string

  • subarray_beams

MCCS sub-array beam.

type

array

items

MCCS subarray beams 3.0

type

object

properties

  • subarray_beam_id

ID of MCCS sub-array beam .

ID must be an integer between 1 and 48.

type

integer

  • apertures

MCCS apertures.

type

array

items

MCCS Aperture ID 3.0

type

object

properties

  • aperture_id

ID of MCCS aperture. Aperture ID, of the form APXXX.YY XXX=station YY=substation.

type

string

  • station_id

IDs of MCCS stations to allocate to this sub-array beam.

Each ID must be between 1 and 512, the maximum number of stations.

type

integer

additionalProperties

True

  • number_of_channels

The allocated number of SPS channels.

ID must be an integer between 8 and 384.

type

integer

additionalProperties

True

additionalProperties

True

  • sdp

SDP assign resources 0.4

SDP configuration specification

type

object

properties

  • interface

type

string

  • transaction_id

type

string

pattern

^txn\-[a-z0-9]+\-[0-9]{8}\-[a-z0-9]+$

  • execution_block

Execution block

Execution_block_0.4

  • resources

SDP external resources 0.4

External resources

type

object

properties

  • receptors

type

array

items

type

string

pattern

[a-zA-Z0-9]([-a-zA-Z0-9]*[a-zA-Z0-9])?

additionalProperties

True

  • processing_blocks

Processing blocks

type

array

items

A Processing Block is an atomic unit of data processing for the purpose of SDP’s internal scheduler. Each PB references a processing script and together with the associated execution block provides all parameters necessary to carry out scheduling - both on TM’s side for observation planning and on SDP’s side - as well as enable processing to locate all required inputs once it is in progress.

PBs are used for both real-time and deferred, batch, processing. An execution block will often contain many Processing Blocks, for example for ingest, self-calibration and Data Product preparation.

Processing_block_0.4

additionalProperties

False

  • csp

LOWCSP assign resources 3.2

CSP configuration specification

type

object

properties

  • pst

LOWCSP PST beams 3.2

Assign section for PST sub-system

type

object

properties

  • pst_beam_ids

List of PST beam Ids to assign to the subarray.

type

array

items

type

integer

additionalProperties

True

  • pss

LOWCSP PSS beams 3.2

Assign section for PSS sub-system

type

object

properties

  • pss_beam_ids

List of PSS beam Ids to assign to the subarray.

type

array

items

type

integer

additionalProperties

True

additionalProperties

True

additionalProperties

True

Execution_block_0.4

type

object

properties

  • eb_id

type

string

pattern

^eb\-[a-z0-9]+\-[0-9]{8}\-[a-z0-9]+$

  • max_length

type

number

  • context

Free-form information from OET, see ADR-54

type

object

  • beams

Beam parameters

type

array

items

Beam parameters for the purpose of the Science Data Processor.

Beam_0.4

  • scan_types

Scan types. Associates scans with per-beam fields & channel configurations

type

array

items

Scan type 0.4

type

object

properties

  • scan_type_id

type

string

  • derive_from

type

string

  • beams

type

object

additionalProperties

False

  • channels

Channels

type

array

items

Spectral windows per channel configuration.

Scan_channels_0.4

  • polarisations

Polarisation definitions

type

array

items

polarisation 0.4

Polarisation definition.

type

object

properties

  • polarisations_id

type

string

  • corr_type

type

array

items

type

string

additionalProperties

False

  • fields

Fields / targets

type

array

items

fields 0.4

Fields / Targets

type

object

properties

  • field_id

type

string

  • phase_dir

phase_dir 0.4

Phase direction

type

object

properties

  • ra

type

array

items

  • dec

type

array

items

  • reference_time

type

string

  • reference_frame

const

ICRF3

additionalProperties

False

  • pointing_fqdn

type

string

additionalProperties

False

additionalProperties

False

Beam_0.4

Beam parameters for the purpose of the Science Data Processor.

type

object

properties

  • beam_id

Name to identify the beam within the SDP configuration.

type

string

  • function

Identifies the type and origin of the generated beam data. This corresponds to a certain kind of calibration or receive functionality SDP is meant to provide for it.

Possible options:

  • visibilities: Correlated voltages from CBF used for calibration and imaging

  • pulsar search: SDP provides calibrations for tied-array beam as well as post-processes and delivers pulsar search data products

  • pulsar timing: SDP provides calibrations for tied-array beam as well as post-processes and delivers pulsar timing data products

  • vlbi: SDP provides calibrations for tied-array beam

  • transient buffer: SDP receives and delivers transient buffer data dumps

enum

visibilities, pulsar search, pulsar timing, vlbi, transient buffer

  • search_beam_id

type

integer

default

null

  • timing_beam_id

type

integer

default

null

  • vlbi_beam_id

type

integer

default

null

  • visibility_beam_id

type

integer

default

null

additionalProperties

False

Scan_channels_0.4

Spectral windows per channel configuration.

type

object

properties

  • channels_id

type

string

  • spectral_windows

type

array

items

Spectral window 0.4

type

object

properties

  • spectral_window_id

type

string

  • count

Number of channels

type

integer

  • start

First channel ID

type

integer

  • stride

Distance between subsequent channel IDs

type

integer

default

null

  • freq_min

Lower bound of first channel

type

number

  • freq_max

Upper bound of last channel

type

number

  • link_map

Channel map that specifies which network link is going to get used to send channels to SDP. Intended to allow SDP to optimise network and receive node configuration.

type

array

default

null

items

additionalProperties

False

additionalProperties

False

Processing_block_0.4

A Processing Block is an atomic unit of data processing for the purpose of SDP’s internal scheduler. Each PB references a processing script and together with the associated execution block provides all parameters necessary to carry out scheduling - both on TM’s side for observation planning and on SDP’s side - as well as enable processing to locate all required inputs once it is in progress.

PBs are used for both real-time and deferred, batch, processing. An execution block will often contain many Processing Blocks, for example for ingest, self-calibration and Data Product preparation.

type

object

properties

  • pb_id

Unique identifier for this processing block.

type

string

pattern

^pb\-[a-z0-9]+\-[0-9]{8}\-[a-z0-9]+$

  • script

script 0.4

Specification of the workflow to be executed along with configuration parameters for the workflow.

type

object

properties

  • kind

The kind of processing script (realtime or batch)

allOf

type

string

enum

realtime, batch

  • name

The name of the processing script

type

string

  • version

Version of the processing script. Uses semantic versioning.

type

string

additionalProperties

False

  • parameters

Configuration parameters needed to execute the workflow. As these parameters will be workflow specific, this is left as an object to be specified by the workflow definition.

type

object

default

null

  • dependencies

A dependency between processing blocks means that one processing block requires something from the other processing block to run - typically an intermediate Data Product. This generally means that

  1. The dependent processing block might only be able to start once the dependency has been fulfilled

  2. Data associated with the dependency must be kept alive until the dependent processing block is finished.

As processing blocks might have many different outputs, the dependency “kind” can be used to specify how this dependency is meant to be interpreted (e.g. “visibilities”, “calibration”…)

type

array

default

null

items

Processing block dependency 0.4

type

object

properties

  • pb_id

type

string

pattern

^pb\-[a-z0-9]+\-[0-9]{8}\-[a-z0-9]+$

  • kind

type

array

items

type

string

additionalProperties

False

  • sbi_ids

Scheduling block instances that the processing block belongs to.

type

array

default

null

items

type

string

pattern

^sbi\-[a-z0-9]+\-[0-9]{8}\-[a-z0-9]+$

additionalProperties

False