ska-mid-dish-b5dc-proxy

Tango proxy to the Band 5 down-converter

Documentation

The documentation for this project, including how to get started with it, can be found in the docs folder, or browsed in the SKA development portal:

• ska-mid-dish-b5dc-proxy documentation

Installation

This project's requirement is managed with poetry and can be installed using a package manager or from source.

From source

• Clone the repo

git clone [email protected]:ska-telescope/ska-mid-dish-b5dc-proxy.git

• Install poetry

pip install poetry

Install the dependencies and the package.

poetry install

Testing

• Run the unit tests

make python-test

- Lint

```bash
make python-lint

Development

Deploy Band 5 Down-Converter(B5dc) Manager with B5dc simulator

• Deploy b5dcproxy with UDP server from ska-mid-dish-dcp-lib

kubectl create namespace b5dc-proxy

$  helm upgrade --install dev charts/ska-mid-dish-b5dc-proxy -n b5dc-proxy \
--set global.minikube=true \
--set global.operator=true \
--set global.dishes="{001,002}" \ # number of instances to deploy; if not specified defaults to 001
--set ska-mid-dish-dcp-lib.enabled=true  \
--set ska-mid-dish-dcp-lib.b5dcSimulator.enabled=true

ska-tango-base is not deployed by default, to deploy it add the --set below:

--set ska-tango-base.enabled=true

Writing documentation

The documentation for this project can be found in the docs folder. For local builds, plantuml is required to render the UML diagrams. Download plantuml.jar from the plantuml website, move it to ./docs/src/utils and run export LOCAL_BUILD=True. Then run the command below and browse the docs from docs/build/html/index.html.

make docs-build html