Developer Guide

This guide covers everything needed to develop, test, and release zppy.

• Project Standards
  • Development Environment
  • Version Control (VC)
  • Code Quality Assurance
  • Continuous Integration / Continuous Delivery (CI/CD)
  • Style Guide
  • API Documentation
• Understanding CI
  • Build Workflow
  • Release Workflow
  • GitHub Actions
• Contributing to This Documentation
  • Getting Started
  • Edit Documentation
  • Initial setup (obsolete/for reference only)
• Tasks (Developer Reference)
  • climo (Developer Reference)
  • ts (Developer Reference)
  • e3sm_to_cmip (Developer Reference)
  • e3sm_diags (Developer Reference)
  • mpas_analysis (Developer Reference)
  • global_time_series (Developer Reference)
  • tc_analysis (Developer Reference)
  • ilamb (Developer Reference)
  • livvkit (Developer Reference)
  • pcmdi_diags (Developer Reference)
  • bundle (Developer Reference)
  • Dependency overview
• Testing zppy
  • Unit tests
  • Integration tests
  • Automated tests (CI)
  • Full release testing directions
• Testing directions for making a release
• How to Prepare a Release
  • Preparing the Documentation
  • Bumping the Version
  • Releasing on GitHub: release candidates
  • Releasing on GitHub: production releases
  • Releasing on conda-forge: release candidates
  • Releasing on conda-forge: production releases
  • Creating a New Version of the Documentation
  • Extra Resources
• Adding a new task
  • The task’s bash file
  • The task’s Python file
  • The main file
  • Update defaults
  • Update the tutorial
  • Explain new parameters
  • Update the tests
• Adding a new set to the E3SM Diagnostics task
  • Example pull requests
  • Handle dependencies
  • Add the new set
• Adding a new plot to Global Time Series
• Testing zppy for E3SM Unified release
  • Parameters
  • Testing zppy on a small simulation
  • Archive simulation using zstash
  • Transfer simulation to other machines
  • Check transfers were successful
  • Extract the data from the archives
  • Testing zppy on other machines
  • Run unit tests and integration tests
• Archive
  • Old testing tutorial (E3SM Unified 1.5.0)
  • Old documentation setup (initial Sphinx configuration)
  • Deprecated parameters