Welcome to DESC CI test’s documentation!

This repository contains a set of Continuous Integration (CI) example workflows, designed to get you started with CI for your DESC software.

The repository contains some dummy code to go with the CI examples, written in Python, yet the CI principles described in the documentation remain the same regardless of the coding language adopted. Because we are demonstrating CI with Python, we use pytest to build our test framework, however again this is up to you, and what works best for your software.

This documentation briefly introduces CI as a concept, how we can use GitHub Actions to manage our CI workflows, and some working example CI workflows, yet note it is not designed as an exhaustive tutorial for each.

Those already familiar with GitHub Actions and CI can skip to the The DESC CI checklist to see our recommended strategy for CI workflows at DESC.

Building a Python package:

• Developing a Python package at DESC
  • The directory structure
  • The pyproject.toml file
  • Automatic versioning
  • Installing your package (from source)
• Publishing your package
  • Publishing to PyPi
  • Publishing to Conda
• Setting up documentation of GitHub pages

Continuous Integration

• What is Continuous Integration (CI)?
  • Starting with a test suite
• CI using GitHub Actions
  • A simple CI example
  • Adding some complexity to our example
  • 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
• The DESC CI checklist

Appendix

• An example pyproject.toml file
• An example ci.yaml file
• NERSC CI files
  • Mirror repository files
  • Status repository files

Indices and tables

• Index

• Module Index

• Search Page