LSST DM Developer Guide¶

This is an internal guide for LSST DM staff. It’s also openly available so that others can understand how we’re building the LSST’s data management subsystem.

This guide includes a mix of normative requirements and helpful, descriptive, pages. When it’s particularly important that you closely follow a standard, we include an annotation box at the top of the page.

Any member of DM can contribute to this guide. It’s published from the https://github.com/lsst-dm/dm_dev_guide GitHub repo. Check out the README to get started.

Jump to: Team · Communications · Project documentation · Work management

Development guides: Overview · C++ · Python · Pybind11 · JavaScript · ReStructuredText · DM Stack · Git · Editors · Legal · User documentation style

Services: Overview · Jenkins · LSST Data Facility

Team¶

Basic information about the LSST Data Management Subsystem and our culture. Learn more about the Data Management Subsystem in LDM-294.

Team-specific pages:

Data Release Production

Communications¶

How to use DM’s communication channels.

Project documentation¶

Controlled documentation and publications.

Technical notes.

Technotes for Stand-Alone Technical Documentation

Work management¶

How DM coordinates work and gets things done.

Development guides¶

Overview of Code Style Guides & Policies¶

C++¶

Python¶

Pybind11¶

JavaScript¶

Documenting JavaScript APIs with JSDoc

ReStructuredText¶

ReStructuredText Style Guide

DM Stack¶

General policies and procedures.

Development.

Documentation.

Overview of the Stack documentation system
Documentation in packages:
- Layout of the doc/ directory
- Topic types for package documentation:
Documentation in the main repository:
- How to add a package to pipelines.lsst.io
Building docs:

Testing.

Packaging.

Git¶

Editors¶

Crowd-sourced recommendations for configuring editors for LSST development (listed alphabetically)