ska_oso_pdm.sb_definition.mccs

The ska_oso_pdm.sb_definition.mccs package contains classes used to define MCCS resource allocations and configurations.

ska_oso_pdm.sb_definition.mccs.mccs_allocation

The ska_oso_pdm.sb_definition.mccs.mccs_allocation module defines which SKA LOW stations should be allocated to a sub-array beam prior to an observation.

../../../_images/ska_oso_pdm_sb_definition_mccs_mccs_allocation.svg

Class diagram for the mccs_allocation module

An example serialisation of this model to JSON is shown below.

  "mccs_allocation": {
    "mccs_allocation_id": "mccs-allocation-74519",
    "selected_subarray_definition": "AA0.5",
    "subarray_beams": [
	{
	    "subarray_beam_id": 1,
	    "apertures": [
		{
		    "station_id": 345,
		    "substation_id": 1,
		    "weighting_key": "uniform"
		},
		{
		    "station_id": 350,
		    "substation_id": 1,
		    "weighting_key": "uniform"
		},
		{
		    "station_id": 352,
		    "substation_id": 1,
		    "weighting_key": "uniform"
		},
		{
		    "station_id": 431,
		    "substation_id": 1,
		    "weighting_key": "uniform"
		}
	    ]
	}
    ]
},

The entities module provides simple Python representations of the structured request and response for the TMC CentralNode.AssignResources and Configure commands.

class Aperture(*, station_id: int, substation_id: int, weighting_key: str = 'uniform')[source]

Aperture specifies how the aperture of a subarray beam should be configured.

Parameters:
  • station_id – ID of station

  • substation_id – ID of sub station

  • weighting_key – weighting key value

class MCCSAllocation(*, mccs_allocation_id: str, selected_subarray_definition: SubArrayLOW, subarray_beams: list[SubarrayBeamConfiguration])[source]

MCCSAllocation is a Python representation of the MCCS allocation segment of a scheduling block.

Parameters:
  • mccs_allocation_id – stations ID’s to allocate

  • selected_subarray_definition – name of pre-defined/standard configuration

  • subarray_beams – subarray beam list

class SubarrayBeamConfiguration(*, apertures: list[Aperture], subarray_beam_id: int, number_of_channels: int | None = None)[source]

SubarrayBeamConfiguration specifies how SKA LOW sub-array should be configured.

Parameters:
  • apertures – list of aperture in this subarray

  • subarray_beam_id – ID of subarray beam this config maps to

  • number_of_channels – number of channels in this subarray beam, this field represents the maximum number of channels that the SBD will require. It should be calculated from the set of CSP configurations instead of being defined by the user but is optional in SubarrayBeamConfiguration for now for backwards compatibility.