LSST DM Developer Guide
Edition: DM-13739
  • Change edition

Getting Started

  • Developer Onboarding Checklist

Processes

  • Team Culture and Conduct Standards
  • DM Development Workflow with Git, GitHub, JIRA and Jenkins
  • Discussion and Decision Making Process (RFC, RFD)
  • Transferring Code Between Packages
  • Project Planning for Software Development
  • JIRA Agile Usage
  • Policy on DM Wiki Use
  • Attending and Presenting at Conferences
  • Publishing Papers and Proceedings

Coding Guides

  • Introduction to DM’s Code Style Guides
  • DM Python Style Guide
  • DM C++ Style Guide
  • DM Pybind11 Style Guide
  • Using C++ Templates
  • Using Boost
  • Using Astropy
  • Using Eigen
  • Software Unit Test Policy
  • Python Unit Testing
  • Unit-Testing Private C++ Functions
  • Coverage Analysis
  • Profiling
  • Logging
  • Debugging Tasks with lsstDebug
  • Python wrappers for C++ with pybind11

Writing Docs

  • Writing change-controlled documentation
  • Technotes for Stand-Alone Technical Documentation
  • ReStructuredText Style Guide
  • Documenting Stack Packages
  • Documenting Python APIs with Docstrings
  • Documenting C++ Code
  • Documenting JavaScript APIs with JSDoc

Developer Tools

  • Configuring your GitHub username in your Slack profile
  • Git Configuration Standards & Recommentations
  • Using Git LFS (Large File Storage) for data repositories
  • JIRA Work Management Recipes
  • Using clang-format for LSST Development
  • SublimeText Configuration for LSST Development
  • Emacs Configuration for LSST Development
  • Vim Configuration for LSST Development

Build, Test, Release

  • Supported Platforms
  • EUPS Tutorial
  • Jenkins ci.lsst.codes Overview
  • Testing the LSST DM Stack with the Jenkins stack-os-matrix Job
  • The LSST Software Build Tool
  • Adding a New Package to the Build
  • Distributing Third-Party Packages with EUPS

Developer Services

  • Using the lsst-dev Server
  • Using the lsst-dev-db Server
  • Using the Verification Cluster
  • Common Dataset Organization and Policy
  • LSST Data Protection Policy
  • Using the Bulk Transfer Server at NCSA
  • NCSA Nebula OpenStack User Guide
  • NCSA Orchestration User Guide

Team Specific Information

  • Data Release Production
LSST DM Developer Guide
  • Docs »
  • Search

© Copyright 2016-2017 Association of Universities for Research in Astronomy, Inc..

Creative Commons License
LSST DM Developer Guide by the LSST Project is licensed under a Creative Commons Attribution 4.0 International License.

LSST documentation is delivered by Fastly.

Built with Sphinx using a theme provided by Read the Docs.

Financial support for LSST comes from the National Science Foundation (NSF) through Cooperative Agreement No. 1258333, the Department of Energy (DOE) Office of Science under Contract No. DE-AC02-76SF00515, and private funding raised by the LSST Corporation. The NSF-funded LSST Project Office for construction was established as an operating center under management of the Association of Universities for Research in Astronomy (AURA). The DOE-funded effort to build the LSST camera is managed by the SLAC National Accelerator Laboratory (SLAC).