Skip to content

Commit

Permalink
Merge pull request #21 from lsst-ts/tickets/DM-43089_2
Browse files Browse the repository at this point in the history
Tickets/dm43089_2: Added references to the XML Unit Standards document
  • Loading branch information
rbovill authored Mar 21, 2024
2 parents 13da278 + 0e2e6c6 commit 42ed946
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
4 changes: 4 additions & 0 deletions System-Architecture/CSC-Overview/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,10 @@ These event topics are received by the listener, which can then be handled for f
Telemetry is the on-going data stream generated by the CSC.
It is published at a set rate.

The full process for defining CSCs and all the topics is described in the `ts_xml README <https://github.com/lsst-ts/ts_xml/blob/main/README.md>`_.
However, of particular interest is the policy regarding defining units in the XML definition files.
For that, please refer to the :ref:`XML_Units` document.

Sources
=======
* `CSC Development <https://confluence.lsstcorp.org/pages/viewpage.action?spaceKey=LTS&title=CSC+Development>`_
Expand Down
18 changes: 18 additions & 0 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,24 @@ Due to the large size and complexity of assembling a single LSST image, a visual

.. _Obs-Ops-Operational-Tutorials:

System Development Guidelines and Policies
==================================================================

The CSC interface definitions are data objects and they are stored in the `ts_xml <https://github.com/lsst-ts/ts_xml>`_ repository.
This is where CSCs and their APIs are defined.
The Service Abstraction Layer (SAL) is an utility that consumes the XML to produce language specific libraries that enable communication over the DDS network.
The procedures for maintaining these definitions are defined in the `ts_xml <https://github.com/lsst-ts/ts_xml>`_ repository itself.
As each CSC is developed under the guidelines of the specific team doing the work, there is no single resource to look at to define CSC development.
However, there are certain system level policies that govern the development processes.

System-Level Policies
---------------------
:ref:`XML_Units`

Team Specific Development Guidelines
------------------------------------
`TSSW Developers Guide <https://tssw-developer.lsst.io>`_.

System Testing, Deployments, and Upgrades
==================================================================

Expand Down

0 comments on commit 42ed946

Please sign in to comment.