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>
team/onboarding team/code-of-conduct team/tools team/focus-friday team/meeting-free-weeks team/empowerment team/drp
Basic information about the LSST Data Management Subsystem and our culture. Learn more about the Data Management Subsystem in 294.
team/onboardingteam/code-of-conductteam/focus-fridayteam/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/mail.rst communications/presenting-at-conferences.rst communications/community-support.rst communications/calendars.rst
How to use DM's communication channels.
communications/slack-culturecommunications/slack-github-usernamecommunications/rfccommunications/rfdcommunications/wikicommunications/presenting-at-conferencescommunications/community-supportcommunications/calendars
project-docs/change-controlled-docs.rst project-docs/publication-policy.rst project-docs/technotes.rst project-docs/test-documentation.rst
Controlled documentation and publications.
project-docs/change-controlled-docsproject-docs/publication-policy
Technical notes.
project-docs/technotesproject-docs/test-documentation
work/flow.rst work/backports.rst work/project-planning.rst work/jira-agile.rst work/jira-tips.rst
How DM coordinates work and gets things done.
work/flowwork/project-planningwork/jira-agilework/jira-tips
coding/intro.rst coding/unit-test-policy.rst
coding/introcoding/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/stylecpp/api-docscpp/clang-formatcpp/testing-private-functionscpp/templatescpp/boostcpp/eigencpp/profilingcpp/compilation-db
python/style python/formatting python/testing python/numpydoc python/astropy python/profiling python/cli
python/stylepython/formattingpython/testingpython/numpydocpython/astropypython/profilingpython/cli
pybind11/style pybind11/how-to
pybind11/stylepybind11/how-to
javascript/jsdoc
javascript/jsdoc
restructuredtext/style
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/building-with-pip stack/moving-to-github-actions stack/license-and-copyright stack/packaging-third-party-eups-dependencies stack/renaming-a-package stack/conda
General policies and procedures.
stack/platformsstack/transferring-codestack/deprecating-interfaces
Development.
- Building a package with the installed Science Pipelines stack
- Developing packages on the LSST Science Platform
stack/loggingstack/debug
Documentation.
stack/documentation-system-overview- Documentation in packages:
stack/layout-of-doc-directorystack/package-documentation-topic-types:stack/package-homepage-topic-typestack/module-homepage-topic-typestack/task-topic-typestack/config-topic-typestack/script-topic-typestack/argparse-script-topic-typestack/generic-guide-topic-type
- Documentation in the main repository:
stack/add-a-package-to-pipelines-lsst-io
- Building docs:
stack/building-single-package-docsstack/building-pipelines-lsst-io-locallystack/building-pipelines-lsst-io-with-documenteer-job
Testing.
stack/jenkins-stack-os-matrixstack/unit-test-coverage
Packaging.
stack/eups-tutorialstack/lsstswstack/adding-a-new-packagestack/moving-to-github-actionsstack/license-and-copyrightstack/packaging-third-party-eups-dependenciesstack/renaming-a-packagestack/conda
git/setup git/git-lfs
git/setupgit/git-lfs
editors/emacs editors/sublime editors/vim editors/vscode
Crowd-sourced recommendations for configuring editors for LSST development (listed alphabetically)
editors/emacseditors/sublimeeditors/vimeditors/vscode
legal/licensing-overview legal/copyright-overview
legal/licensing-overviewlegal/copyright-overview
user-docs/index
user-docs/indexuser-docs/lsst-specific-content-style-guideuser-docs/topic-based-documentation
it/itsc
it/itsc
jenkins/getting-started
jenkins/getting-started
idf/overview
idf/overview
usdf/onboarding.rst usdf/lsst-login usdf/kubernetes usdf/storage usdf/batch usdf/stack usdf/datasets usdf/object-store
usdf/onboardingusdf/lsst-loginusdf/kubernetesusdf/storageusdf/batchusdf/stackusdf/datasetsusdf/object-store