Welcome to DESC’s Python packaging and Continuous Integration guide!

This documentation is a quickstart guide for writing a Python package at DESC. It includes instructions on how to start a Python package from scratch, how to document that package, how to publish that package, and how to keep the package well tested and stable using Continuous Integration (CI) workflows and GitHub Actions.

The guide comes with some accompanying demo code and example CI workflows, which can be found in the desc-continuous-integration repository.

Those already familiar with GitHub Actions, and CI in general, that just want to see our recommended strategy for CI workflows at DESC can skip to The DESC CI checklist.

Python packaging at DESC

• Building a Python package
  • The directory structure
  • The pyproject.toml file
  • Automatic versioning
  • Installing your package (from source)
• Publishing a Python package
  • Publishing to PyPI
  • Publishing to Anaconda
• Documenting a Python package
  • Writing documentation
  • Publishing documentation

Continuous Integration at DESC

• What is Continuous Integration (CI)?
  • Starting with a test suite
• GitHub Actions
  • Example 1: A simple CI workflow
  • Example 2: Going beyond just testing
  • CI and the DESC Python environment
• CI at NERSC using GitLab
  • Getting set up
  • Building a GitLab CI workflow for your repository
  • Things to think about with CI at NERSC
• Example CI workflows from DESC repositories
  • The Core Cosmology Library
  • imSim
  • tables_io
• Example CI workflows from DESC pipelines
• The DESC CI checklist

Appendix

• Quick-example pyproject.toml
• Quick-example ci_workflow.yml
• NERSC CI files
  • Mirror repository files
  • Status repository files

Indices and tables

• Index

• Module Index

• Search Page