.. HOME SECTION ==================================================

.. Hidden toctree to manage the sidebar navigation.

.. toctree::
  :maxdepth: 1
  :caption: Home
  :hidden:

  CHANGELOG

.. COMMUNITY SECTION ==================================================

.. Hidden toctree to manage the sidebar navigation.

.. toctree::
  :maxdepth: 2
  :caption: Public API Documentation
  :hidden:

  api/tmcsim

==============
ska-oso-tmcsim
==============

Overview
========

This project holds code used to test OSO's TMC Simulator. It contains the source code for the
simulator as well as a Helm chart that deploys the simulator.

Mid and Low Simulations
========================

The OSO TMC simulator provides CentralNode and Subarray device classes which simulate the corresponding TMC classes.
As these behave the same for Mid and Low, the OSO TMC simulator uses the same classes to simulate both, with the difference
being the name for the devices.

The ska-oso-tmcsim Helm chart deploys 2 DeviceServer Kubernetes resources, one for each telescope. The OSO TMC Simulator Tango devices then
run on the pods deployed via this resource: the Mid devices (ska_mid/tm_central/central_node` `ska_mid/tm_subarray_node/1`) run on the Mid DeviceServer
and the Low devices (ska_low/tm_central/central_node` `ska_low/tm_subarray_node/1`) on the Low DeviceServer.

Additionally, a CSP leaf node device server will be running on the DeviceServer for each telescope with the following TRLs: mid-tmc/subarray-leaf-node-csp/01 and low-tmc/subarray-leaf-node-csp/01

A Subarray Quality Monitor (SQM) is deployed for each subarray, implemented as a Transducer device that
subscribes to the CBF ``processorsReadyPercent`` attribute and derives a ``readyToScan`` flag.
The Transducer TRLs follow ``mid-tmc/subarray-quality-monitor/NN`` and ``low-tmc/subarray-quality-monitor/NN``.

A CBF simulator device is also deployed for each subarray, which publishes an ``processorsReadyPercent`` attribute
that ramps from 0 to 100 when the corresponding SubArrayNode enters READY.
The CBF simulator TRLs follow the pattern ``sim-mid-cbf/subarray/NN`` and ``sim-low-cbf/subarray/NN``.


These devices can be enabled/disabled individually in the Helm values, and the domain name can also be configured.

Quickstart
==========
This project uses the standard SKA Make targets to control deployment of the project and execution of project tests,
e.g., ``make k8s-install-chart``, ``make k8s-test``, and ``make k8s-uninstall-chart`` to start the OSO TMC simulator
and execute the integration tests. Unit and component tests can be run with ``make python-test`` without installing
the Helm charts.