CCPP Technical Documentation

• 1. CCPP Overview
  • 1.1. How to Use this Document
• 2. CCPP-Compliant Physics Parameterizations
  • 2.1. General Rules
  • 2.2. Input/output Variable (argument) Rules
  • 2.3. Coding Rules
  • 2.4. Parallel Programming Rules
  • 2.5. Scientific Documentation Rules
    • 2.5.1. Doxygen Comments and Commands
    • 2.5.2. Doxygen Documentation Style
    • 2.5.3. Doxygen Configuration
    • 2.5.4. Using Doxygen
• 3. CCPP Configuration and Build Options
• 4. Constructing Suites
  • 4.1. Suite Definition File
    • 4.1.1. Groups
    • 4.1.2. Subcycling
    • 4.1.3. Order of Schemes
  • 4.2. Interstitial Schemes
  • 4.3. SDF Examples
    • 4.3.1. Simplest Case: Single Group and no Subcycling
    • 4.3.2. Case with Multiple Groups
    • 4.3.3. Case with Subcycling
    • 4.3.4. Operational GFS v15 Suite
• 5. Autogenerated Physics Caps
  • 5.1. Dynamic Build Caps
  • 5.2. Static Build Caps
• 6. Host Side Coding
  • 6.1. Variable Requirements on the Host Model Side
  • 6.2. Metadata Variable Tables in the Host Model
  • 6.3. CCPP Variables in the SCM and UFS Atmosphere Host Models
  • 6.4. CCPP API
    • 6.4.1. Data Structure to Transfer Variables between Dynamics and Physics
    • 6.4.2. Adding and Retrieving Information from cdata (dynamic build option)
    • 6.4.3. Initializing and Finalizing the CCPP
    • 6.4.4. Running the physics
    • 6.4.5. Initializing and Finalizing the Physics
  • 6.5. Host Caps
    • 6.5.1. SCM Host Cap
    • 6.5.2. UFS Atmosphere Host Cap
• 7. CCPP Code Management
  • 7.1. Organization of the Code
    • 7.1.1. UFS Atmosphere
    • 7.1.2. SCM
    • 7.1.3. Directory Structure of ccpp/framework
    • 7.1.4. Directory Structure of ccpp/physics
  • 7.2. GitHub Workflow (setting up development repositories)
    • 7.2.1. Creating Forks
    • 7.2.2. Checking out the Code (NEMSfv3gfs)
    • 7.2.3. Checking out the Code (SCM)
  • 7.3. Committing Changes to your Fork
  • 7.4. Contributing Code, Code Review Process
    • 7.4.1. Creating a PR
• 8. Technical Aspects of the CCPP Prebuild
  • 8.1. Prebuild Script Function
  • 8.2. Script Configuration
  • 8.3. Running ccpp_prebuild.py
  • 8.4. Troubleshooting
• 9. Building and Running Host Models
  • 9.1. SCM
    • 9.1.1. System Requirements, Libraries, and Tools
    • 9.1.2. Building and Running the SCM
  • 9.2. UFS Atmosphere
    • 9.2.1. System Requirements, Libraries, and Compilers
    • 9.2.2. Building the UFS Atmosphere
    • 9.2.3. Running the UFS Atmosphere Using the Regression Tests (RTs)
• 10. Tips for Adding a New Scheme
• 11. Acronyms
• 12. Glossary