Commit fc9c4655 authored by Elisabetta Giani's avatar Elisabetta Giani
Browse files

fix-configure-after-scan: updated CSP.LMC Common Package documentation.

parent 9e6052bb

docs/src/CspCapability.rst

0 → 100644
+84 −0
Original line number Diff line number Diff line 
Capabilities represent the CSP schedulable resources and provide API that can be used to

configure, monitor and control resources that implement signal processing functionality.

During normal operations, TM uses the sub-array API to assign capabilities to the sub-array, configure

sub-array Processing Mode, start and stop scan. |br|

The CSP.LMC Common Package implements the capabilities that are shared between LOW and MID instances. |br|

These are:



* :ref:`CSP Search Beam Capability <CSP-SearchBeam-Capability>`

* :ref:`CSP Timing Beam Capability <CSP-TimingBeam-Capability>`

* :ref:`CSP VLBI Beam Capability <CSP-VlbiBeam-Capability>`



.. _CSP-SearchBeam-Capability:



CSP.LMC Search Beam Capability 

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

The Search Beam Capability exposes the attributes and commands to monitor and control beamforming and PSS

processing in a single beam. |br|

The mapping between an instance of the CSP Search Beam and the internal CSP Sub-element components performing

beamforming and search is established at initialization and is permanent.



CSP.LMC SearchBeamCapability API Documentation

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



.. autoclass:: csp_lmc_common.CspSearchBeamCapability.CspSearchBeamCapability

   :members:

   :member-order:

   :private-members:

   :show-inheritance:

   :undoc-members:



.. _CSP-TimingBeam-Capability:



CSP.LMC Timing Beam Capability 

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

The Timing Beam Capability exposes the attributes and commands to monitor and control beamforming and PST

processing in a single beam. |br|

The mapping between an instance of the CSP Search Beam and the internal CSP Sub-element components performing

beamforming and search is established at initialization and is permanent.





CSP.LMC TimingBeamCapability API Documentation

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

.. autoclass:: csp_lmc_common.CspTimingBeamCapability.CspTimingBeamCapability

   :members:

   :member-order:

   :noindex:

   :private-members:

   :show-inheritance:

   :undoc-members:



.. _CSP-VlbiBeam-Capability:



CSP.LMC VLBI Beam Capability 

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

The VLBI Beam Capability exposes the attributes and commands to monitor and control beamforming and VLBI

processing in a single beam. |br|



CSP.LMC VlbiBeamCapability API Documentation

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

.. autoclass:: csp_lmc_common.CspVlbiBeamCapability.CspVlbiBeamCapability

   :members:

   :private-members:

   :special-members:

   :show-inheritance:

   :undoc-members:

   :noindex:



.. _CSP-CapabilityMonitor:



CSP.LMC CapabilityMonitor

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

This device...



CSP.LMC CapabilityMonitor API Documentation

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

.. autoclass:: csp_lmc_common.CspCapabilityMonitor.CspCapabilityMonitor

   :members:

   :private-members:

   :special-members:

   :show-inheritance:

   :undoc-members:

   :noindex:

docs/src/CspLmcCommon.rst

0 → 100644
+69 −0
Original line number Diff line number Diff line 
.. Documentation



.. |br| raw:: html



   <br />



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

CSP.LMC Common Package

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



General requirements for the monitor and control functionality are the same in both telescopes.

In addition two of three other CSP Sub-elements, namely PSS and PST, have the same functionality and use the same

design for both the telescopes. |br|

Functionality common to Low and Mid CSP.LMC includes: communication framework, logging, archiving, alarm generation,

subarraying, some of the functionality realated to handling observing mode changes, Pulsar Search and

Pulsar Timing, and to some extent Very Long Baseline Interferometry (VLBI). |br|

The difference between LOW and MID CSP.LMC is mostly due to the different receivers (dishes vs stations) and different

CBF functionality and design. More than the 50% of the CSP.LMC functionality is common for both

telescopes. |br|

The CSP.LMC Common Package comprises all the software components and functionality common to LOW and MID CSP.LMC

and is used as a base for development of the Low CSP.LMC and Mid CSP.LMC software. |br|

The *CSP.LMC Common Package* is delivered as a part of each CSP.LMC release, via a Python package that can be used as 

required for maintenance and upgrade. |br|

CSP.LMC implements a high level interface (API) that Telescope Manager (TM), or other authorized

client, can use to monitor and control CSP as a single instrument. |br|

At the same time, CSP.LMC provides high level commands that the TM can use to sub-divide the array

into up to 16 sub-arrays, i.e. to assign station/receptors to sub-arrays, and to operate each 

sub-array independently and conccurently with all othe sub-arrays. |br|

The top-level software components provided by CSP.LMC API are:



* :ref:`Csp Master <CSP-Master>`

* :ref:`Csp Subarray <CSP-Subarray>`

* CSP Alarm Handler

* CSP Logger

* CSP TANGO Facility Database

* Input processor Capability (receptors/stations)

* :ref:`Search Beam Capability <CSP-Capability>`

* :ref:`Timing Beam Capability <CSP-Capability>`

* :ref:`VLBI Beam Capability <CSP-Capability>`



Components listed above are implemented as TANGO devices, i.e. classes that implement standard TANGO API.

The CSP.LMC TANGO devices are based on the standard SKA1 TANGO Element Devices provided via the *SKA Base Classes package*.



.. _CSP-Master:



**************

CSP.LMC Master

**************



.. include:: CspMaster.inc





.. _CSP-Subarray:



****************

CSP.LMC Subarray

****************



.. include:: CspSubarray.inc



.. _CSP-Capability:



********************

CSP.LMC Capabilities

********************



.. include:: CspCapability.inc

docs/src/CspMaster.inc

0 → 100644
+16 −0
Original line number Diff line number Diff line 
The CSP Master provides API for monitor and control the CSP Element. CSP Master implements CSP Element-level

status indicators, configuration parameters, housekeeping commands. |br|

CSP Master is the primary point of access for CSP Monitor and Control. |br|

CSP Master maintains the pool of schedulable resources, and it can relies on the 

CSP CapabilityMonitor device, as needed.



CspMaster API  Documentation 

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



.. autoclass:: csp_lmc_common.CspMaster.CspMaster

   :members:

   :noindex:

   :undoc-members:

   :member-order:

   :show-inheritance:

docs/src/CspMaster.rst

deleted100644 → 0
+0 −10
Original line number Diff line number Diff line 
.. Documentation



CspMaster Class Documentation 

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



.. automodule:: csp_lmc_common.CspMaster

   :members:

   :undoc-members:

   :show-inheritance:

   :member-order:

docs/src/CspSubarray.rst→docs/src/CspSubarray.inc

+16 −17
Original line number Diff line number Diff line 
##############

CSP Subarrays

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

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

and monitored via subarrays.

and monitored via subarrays. |br|



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.
@@ -13,7 +10,7 @@ TM accesses directly a CSP Subarray to: 
* 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:
@@ -26,7 +23,10 @@ may be used in shared manner by more then one subarray. 


Inherent Capabilities

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

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

Each CSP subarray has also a set of permanently assigned *inherent Capabilities*: the number and type is different

for LOW and MID instance. |br|

Only the Inherent Capabilities related to the Processing Mode are common to both instances. |br|

These are:



* Correlation

* PSS
@@ -34,10 +34,9 @@ Each CSP subarray has also four permanently assigned *inherent Capabilities*: 
* 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
@@ -47,17 +46,17 @@ When a complete and coherent scan configuration is received and the subarray con 


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.

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

CSP subarray as a whole and for individual assigned resources. |br|

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 

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

CspSubarray Class API  Documentation

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



.. automodule:: csp_lmc_common.CspSubarray

.. autoclass:: csp_lmc_common.CspSubarray.CspSubarray

   :members:

   :undoc-members:

   :show-inheritance:

   :member-order:

   :noindex:

   :private-members:

   :undoc-members: