Developer Guide

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

• Project Standards
  • Development Environment
  • Version Control (VC)
  • Continuous Integration / Continuous Delivery (CI/CD)
  • API Documentation
• Contributing to This Documentation
  • Getting Started
  • Edit Documentation
• Parameter checking & inferring – for developers
• Tasks (Developer Reference)
  • bundle (Developer Reference)
  • climo (Developer Reference)
  • ts (Developer Reference)
  • e3sm_to_cmip (Developer Reference)
  • tc_analysis (Developer Reference)
  • e3sm_diags (Developer Reference)
  • mpas_analysis (Developer Reference)
  • global_time_series (Developer Reference)
  • ilamb (Developer Reference)
  • livvkit (Developer Reference)
  • pcmdi_diags (Developer Reference)
• Testing zppy
  • Step 1: Determine what the current expected results are
  • Step 2: Review changes since expected results were updated
  • Step 3: Set up environments for called packages
  • Step 4: Set up zppy environment
  • Step 5: Launch zppy jobs
  • Step 6: Launch zppy jobs – bundles part 2
  • Step 7: Review finished returns
  • Step 8: Run Python tests
• Updating expected results for the tests
  • Machine-specific setup
  • Process
• How to Prepare a Release
  • Preparing a release candidate
  • Preparing a production release
  • 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
• Examples: Adding a new set to the E3SM Diagnostics task
  • Example pull requests
  • Handle dependencies
  • Add the new set
• Archive
  • How to set up new documentation