Skip to content

lsst-sitcom/sitcomtn-100

Repository files navigation

Website CI

The Rapid Analysis Framework and RubinTV

SITCOMTN-100

Documentation on the architecture of the Rapid Analysis Framework, including its relationship to RubinTV.

Links:

Build this technical note

You can clone this repository and build the technote locally if your system has Python 3.11 or later:

.. code-block:: bash

git clone https://github.com/lsst-sitcom/sitcomtn-100
cd sitcomtn-100
make init
make html

Repeat the make html command to rebuild the technote after making changes. If you need to delete any intermediate files for a clean build, run make clean.

The built technote is located at _build/html/index.html.

Publishing changes to the web

This technote is published to https://sitcomtn-100.lsst.io whenever you push changes to the main branch on GitHub. When you push changes to a another branch, a preview of the technote is published to https://sitcomtn-100.lsst.io/v.

Editing this technical note

The main content of this technote is in index.md (a Markdown file parsed as CommonMark/MyST). Metadata and configuration is in the technote.toml file. For guidance on creating content and information about specifying metadata and configuration, see the Documenteer documentation: https://documenteer.lsst.io/technotes.

Releases

No releases published

Packages

No packages published