Describes the database infrastructure that supports end-user access to Butler metadata via the Rubin Science Platform.
Links:
- Publication URL: https://dmtn-297.lsst.io
- Alternative editions: https://dmtn-297.lsst.io/v
- GitHub repository: https://github.com/lsst-dm/dmtn-297
- Build system: https://github.com/lsst-dm/dmtn-297/actions/
You can clone this repository and build the technote locally if your system has Python 3.11 or later:
git clone https://github.com/lsst-dm/dmtn-297
cd dmtn-297
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
.
This technote is published to https://dmtn-297.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://dmtn-297.lsst.io/v.
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.