index.rst

LSST DM Developer Guide

This is an internal guide for LSST DM staff during project construction, and for Rubin Observatory Data Production staff in operations. It's also openly available so that others can understand how we're building the LSST's data management subsystem. In some cases, other Rubin groups (for example Telescope & Site Software) have chosen to follow various sections as it applies to them.

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 <part-team> · Communications <part-communications> · Project documentation <part-project-docs> · Work management <part-work>

Development guides: Overview <part-guides> · C++ <part-cpp> · Python <part-python> · Pybind11 <part-pybind11> · JavaScript <part-javascript> · ReStructuredText <part-rst> · DM Stack <part-dm-stack> · Git <part-git> · Editors <part-editors> · Legal <part-legal> · User documentation style <part-user-doc-style-guide>

Services: Overview <part-services> · Jenkins <part-jenkins> · LSST Data Facility <part-ldf>

---

team/onboarding team/code-of-conduct team/focus-friday team/meeting-free-weeks team/empowerment team/drp

Team

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

• team/onboarding
• team/code-of-conduct
• team/focus-friday
• team/empowerment

Team-specific pages:

• team/drp

communications/slack-culture.rst communications/slack-github-username.rst communications/rfc.rst communications/rfd.rst communications/wiki.rst communications/presenting-at-conferences.rst communications/community-support.rst communications/calendars.rst

Communications

How to use DM's communication channels.

• communications/slack-culture
• communications/slack-github-username
• communications/rfc
• communications/rfd
• communications/wiki
• communications/presenting-at-conferences
• communications/community-support
• communications/calendars

project-docs/change-controlled-docs.rst project-docs/publication-policy.rst project-docs/technotes.rst project-docs/test-documentation.rst

Project documentation

Controlled documentation and publications.

• project-docs/change-controlled-docs
• project-docs/publication-policy

Technical notes.

• project-docs/technotes
• project-docs/test-documentation

work/flow.rst work/backports.rst work/project-planning.rst work/jira-agile.rst work/jira-tips.rst

Work management

How DM coordinates work and gets things done.

• work/flow
• work/project-planning
• work/jira-agile
• work/jira-tips

Development guides

coding/intro.rst coding/unit-test-policy.rst

Overview of Code Style Guides & Policies

• coding/intro
• coding/unit-test-policy

cpp/style cpp/api-docs cpp/clang-format cpp/testing-private-functions cpp/templates cpp/boost cpp/eigen cpp/profiling cpp/compilation-db cpp/code-analysis

C++

• cpp/style
• cpp/api-docs
• cpp/clang-format
• cpp/testing-private-functions
• cpp/templates
• cpp/boost
• cpp/eigen
• cpp/profiling
• cpp/compilation-db
• cpp/code-analysis

python/style python/formatting python/testing python/numpydoc python/astropy python/profiling python/cli

Python

• python/style
• python/formatting
• python/testing
• python/numpydoc
• python/astropy
• python/profiling
• python/cli

pybind11/style pybind11/how-to

Pybind11

• pybind11/style
• pybind11/how-to

javascript/jsdoc

JavaScript

• javascript/jsdoc

restructuredtext/style

ReStructuredText

• restructuredtext/style

stack/platforms stack/transferring-code stack/deprecating-interfaces stack/logging stack/debug stack/documentation-system-overview stack/layout-of-doc-directory stack/package-documentation-topic-types stack/add-a-package-to-pipelines-lsst-io stack/building-single-package-docs stack/building-pipelines-lsst-io-locally stack/building-pipelines-lsst-io-with-documenteer-job stack/jenkins-stack-os-matrix stack/unit-test-coverage.rst stack/eups-tutorial stack/lsstsw stack/adding-a-new-package stack/moving-to-github-actions stack/license-and-copyright stack/packaging-third-party-eups-dependencies stack/renaming-a-package stack/conda

DM Stack

General policies and procedures.

• stack/platforms
• stack/transferring-code
• stack/deprecating-interfaces

Development.

• Building a package with the installed Science Pipelines stack
• Developing packages on the LSST Science Platform
• stack/logging
• stack/debug

Documentation.

• stack/documentation-system-overview
• Documentation in packages:
  • stack/layout-of-doc-directory
  • stack/package-documentation-topic-types:
    • stack/package-homepage-topic-type
    • stack/module-homepage-topic-type
    • stack/task-topic-type
    • stack/config-topic-type
    • stack/script-topic-type
    • stack/argparse-script-topic-type
    • stack/generic-guide-topic-type
• Documentation in the main repository:
  • stack/add-a-package-to-pipelines-lsst-io
• Building docs:
  • stack/building-single-package-docs
  • stack/building-pipelines-lsst-io-locally
  • stack/building-pipelines-lsst-io-with-documenteer-job

Testing.

• stack/jenkins-stack-os-matrix
• stack/unit-test-coverage

Packaging.

• stack/eups-tutorial
• stack/lsstsw
• stack/adding-a-new-package
• stack/moving-to-github-actions
• stack/license-and-copyright
• stack/packaging-third-party-eups-dependencies
• stack/renaming-a-package
• stack/conda

git/setup git/git-lfs

Git

• git/setup
• git/git-lfs

editors/emacs editors/sublime editors/vim editors/vscode

Editors

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

• editors/emacs
• editors/sublime
• editors/vim

legal/licensing-overview legal/copyright-overview

Legal

• legal/licensing-overview
• legal/copyright-overview

user-docs/index

User documentation style

• user-docs/index
• user-docs/lsst-specific-content-style-guide

Service guides

it/itsc

IT overview

• it/itsc

jenkins/getting-started

Jenkins CI

• jenkins/getting-started

services/lsst-login services/lsst-devl services/batch services/software services/datasets services/data_protection services/ncsa_bulk_transfer services/orchestration/index services/ldf-tickets services/ldf-resources services/storage services/monitoring_applications services/lsst-dev services/lsst-db services/verification

LSST Data Facility services

• services/lsst-login
• services/lsst-devl
• services/batch
• services/software
• services/datasets
• services/data_protection
• services/ncsa_bulk_transfer
• services/orchestration/index
• services/ldf-tickets
• services/ldf-resources
• services/storage
• services/monitoring_applications
• services/lsst-dev
• services/lsst-db
• services/verification

idf/overview

Interim Data Facility

• idf/overview