Skip to content

lsst-ts/ts_salkafka

Repository files navigation

ts_salkafka

Forward samples from SAL/DDS to Kafka to populate the engineering facilities database at Vera C. Rubin Telescope.

Documentation: https://ts-salkafka.lsst.io

The package is compatible with setuptools, as well as the eups package management system and scons build system. Assuming you have the basic Vera C. Rubin LSST DM stack installed you can do the following, from within the package directory:

  • setup -r . to setup the package and dependencies, at which point the unit tests can be run and the package can be used "in place".
  • pytest to run the unit tests.
  • python setup.py install to install the software.
  • package-docs build to build the documentation. This requires documenteer; see building single package docs for installation instructions.

This code uses pre-commit to maintain black formatting and flake8 compliance. To enable this:

  • Run pre-commit install once.
  • If directed, run git config --unset-all core.hooksPath once.