From September 2018 to March 2019, LSST Data Management (DM) and Google Cloud conducted a proof of concept engagement to investigate the utility, applicability, and performance of Google Cloud services with regard to various DM needs. This document describes what was accomplished in each area, including measurements obtained, and presents some conclusions about how the engagement went overall.
Links:
- Publication URL: https://dmtn-125.lsst.io
- Alternative editions: https://dmtn-125.lsst.io/v
- GitHub repository: https://github.com/lsst-dm/dmtn-125
- Build system: https://travis-ci.org/lsst-dm/dmtn-125
You can clone this repository and build the technote locally with Sphinx:
git clone https://github.com/lsst-dm/dmtn-125
cd dmtn-125
pip install -r requirements.txt
make html
Note
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-125.lsst.io will be automatically rebuilt whenever you push your changes to the master
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-bib
Add new bibliography items to the local.bib
file in the root directory (and later add them to lsst-texmf).