Updated docs content.

.. Documentation

CspMaster Class Documentation 

================================

.. automodule:: csp_lmc_common.CspMaster

   :members:

   :undoc-members:

   :show-inheritance:

   :member-order:

##############

CSP Subarrays

##############

The core CSP functionality, configuration and execution of signal processing, is configured, controlled 

and monitored via subarrays.

CSP Subarray makes provision to TM to configure a subarray, select Processing Mode and related parameters, 

specify when to start/stop signal processing and/or generation of output products.  

TM accesses directly a CSP Subarray to:

* Assign resources 

* Configure a scan

* Control and monitor states/operations

Resources assignment

=====================

The assignment of Capabilities to a subarray (*subarray composition*) is performed 

in advance of a scan configuration.  

Assignable Capabilities for CSP Subarrays are:

* receptors (MID) or stations (LOW) 

* tied-array beams: Search Beams, Timing Beams and Vlbi Beams.

In general resource assignment to a subarray is exclusive, but in some cases the same Capability instance

may be used in shared manner by more then one subarray.

Inherent Capabilities

---------------------

Each CSP subarray has also four permanently assigned *inherent Capabilities*: 

* Correlation

* PSS

* PST

* VLBI

An inherent Capability can be enabled or disabled, but cannot assigned or removed to/from a subarray. 

They correspond to the CSP Mid Processing Modes and are configured via a scan configuration.

Scan configuration

====================

TM provides a complete scan configuration to a subarray via an ASCII JSON encoded string.

Parameters specified via a JSON string are implemented as TANGO Device attributes  

and can be accessed and modified directly using the buil-in TANGO method *write_attribute*.

When a complete and coherent scan configuration is received and the subarray configuration 

(or re-configuration) completed,  the subarray it's ready to observe.

Control and Monitoring

======================

Each CSP Subarray maintains and report the status and state transitions for the 

CSP subarray as a whole and for the individual assigned resources.

In addition to pre-configured status reporting, a CSP Subarray makes provision for the TM and any authorized client, 

to obtain the value of any subarray attribute.

CspSubarray Class Documentation 

================================

.. automodule:: csp_lmc_common.CspSubarray

   :members:

   :undoc-members:

   :show-inheritance:

   :member-order:

.. Documentation

CspMaster Class Documentation 

================================

.. automodule:: csp_lmc_mid.MidCspMasterBase

   :members:

   :undoc-members:

   :show-inheritance:

   :member-order:

##############

CSP_Mid Subarrays

##############

CSP_Mid signal processing configuration and control is via sub-arrays and scans.

The CSP_Mid sub-array receives configuration per scan.

The following CSP_Mid sub-array parameters must be set in advance of a scan (before the

command  *Configure* is received):

* Receptors that belong to sub-arrays. In order for a CSP_Mid sub-array to accept a scan configuration,

  at least one receptor must be assigned to the sub-arrays. If no receptors are assigned to a sub-array, the sub-array is 

  empty and its state is *OFF*.

* Tied-array beams to be used by the sub-array. Search Beams, Timing Beams and Vlbi Beams are assigned via the CSP_Mid sub-array.

  TM may specify the number of beams to be used or, alternatively, identify the Capability instances to be used

  via their TANGO Fully Qualified Domain Name (FQDN). Search Beams must be assigned in advance of a scan that requires

  PSS processing. The same for Timing and Vlbi Beams.

Receptors assignment

=====================

The assignment of receptors to a MID subarray is performed 

in advance of a scan configuration.  

Up to 197 receptors can be assigne to one sub-array.

Receptos assignment to a subarray is exclusive: one receptor can be assigned only to one subarray.

During assignement, the  CSP_Mid subarray checks if the requested receptor is already assigned

to another sub-arry, and in this case it logs a warning message.

Inherent Capabilities

---------------------

Each CSP subarray has also four permanently assigned *inherent Capabilities*: 

* Correlation

* PSS

* PST

* VLBI

An inherent Capability can be enabled or disabled, but cannot assigned or removed to/from a subarray. 

They correspond to the CSP Mid Processing Modes and are configured via a scan configuration.

Scan configuration

====================

TM provides a complete scan configuration to a subarray via an ASCII JSON encoded string.

Parameters specified via a JSON string are implemented as TANGO Device attributes  

and can be accessed and modified directly using the buil-in TANGO method *write_attribute*.

When a complete and coherent scan configuration is received and the subarray configuration 

(or re-configuration) completed,  the subarray it's ready to observe.

Control and Monitoring

======================

Each CSP Subarray maintains and report the status and state transitions for the 

CSP subarray as a whole and for the individual assigned resources.

In addition to pre-configured status reporting, a CSP Subarray makes provision for the TM and any authorized client, 

to obtain the value of any subarray attribute.

MidCspSubarray Class Documentation 

================================

.. automodule:: csp_lmc_mid.MidCspSubarrayBase

   :members:

#import tango

#import skabase

#autodoc_mock_imports = ['PyTango', 'tango', 'tango.server','run', 'DeviceMeta', 'command',

#                 'future', 'future.utils', 'logging', 'logging.handlers', 'skabase',

#                 'skabase.auxiliary', 'skabase.SKAMaster.SKAMaster', 'SKAMaster',

#                 'skabase.SKASubarray.SKASubarray', 'SKASubarray','numpy

#                 ]

autodoc_mock_imports = ['PyTango', 'tango', 'tango.server','run', 'DeviceMeta', 'command',

                 'future', 'future.utils', 'logging', 'logging.handlers', 'skabase',

                 'skabase.auxiliary', 'skabase.SKAMaster.SKAMaster', 'SKAMaster',

                 'skabase.SKASubarray.SKASubarray', 'SKASubarray','numpy'

                 ]

autodoc_member_order = 'bysource'

import os

import sys

sys.path.append(os.path.abspath('../../csp-lmc-common/'))

sys.path.append(os.path.abspath('../../csp-lmc-mid/'))

import sphinx_rtd_theme