The Rubin Science Platform (RSP) is a collection of services intended to provide the Rubin scientific community with "next-to-the-data" exploration and analysis capabilities. It refers to the major three user-facing aspects (Portal, Notebook, API) as well as the infrastructure services that support them. Core user-facing services, infrastructure services as well as "guest" services all make use of a single cloud-native deployment infrastructure.
This document describes the RSP system architecture, key technical decisions, a description of user-facing and supporting services, an explanation of the deployment infrastructure, and an outline of current operational environments.
This is a live document describing existing capabilities as they are currently available as our system is continuously evolved to meet its design requirements as well as address future technical challenges and emerging user needs.
Links:
- Publication URL: https://dmtn-212.lsst.io
- Alternative editions: https://dmtn-212.lsst.io/v
- GitHub repository: https://github.com/lsst-dm/dmtn-212
- Build system: https://github.com/lsst-dm/dmtn-212/actions/
You can clone this repository and build the technote locally with Sphinx:
git clone https://github.com/lsst-dm/dmtn-212
cd dmtn-212
pip install -r requirements.txt
make htmlNote
In a Conda environment, pip install -r requirements.txt doesn't work as expected. Instead, pip install the packages listed in requirements.txt individually.
The built technote is located at _build/html/index.html.
You can edit the index.rst file, which is a reStructuredText document. The DM reStructuredText Style Guide is a good resource for how we write reStructuredText.
Remember that images and other types of assets should be stored in the _static/ directory of this repository. See _static/README.rst for more information.
The published technote at https://dmtn-212.lsst.io will be automatically rebuilt whenever you push your changes to the main branch on GitHub.
This technote's metadata is maintained in metadata.yaml. In this metadata you can edit the technote's title, authors, publication date, etc.. metadata.yaml is self-documenting with inline comments.
The bibliography files in lsstbib/ are copies from lsst-texmf. You can update them to the current lsst-texmf versions with:
make refresh-bibAdd new bibliography items to the local.bib file in the root directory (and later add them to lsst-texmf).