HAFS User’s Guide (develop)

• 1. Background Information
  • 1.1. Introduction
  • 1.2. Technical Overview
    • 1.2.1. Prerequisites for Working with the HAFS Repository
    • 1.2.2. HAFS GitHub Repository Management
    • 1.2.3. HAFS Directory Structure
    • 1.2.4. HAFS Submodules
    • 1.2.5. HAFS Workflow Schematic
    • 1.2.6. HAFS v2.0.0 Operational Updates
• 2. Building, Running, and Testing HAFS
  • 2.1. HAFS Quick Start Guide
    • 2.1.1. Clone and Checkout the Repository
    • 2.1.2. Build and Install HAFS
    • 2.1.3. Run the HAFS System
  • 2.2. HAFS Extended Quick Start Guide
    • 2.2.1. Clone and Checkout the Repository
    • 2.2.2. Build and Install HAFS
    • 2.2.3. Run the HAFS System
  • 2.3. Regression Test
• 3. Customizing The Workflow
  • 3.1. Physics Schemes in HAFS
    • 3.1.1. Suite Comparison
    • 3.1.2. Land/Ocean Surface Schemes
    • 3.1.3. Surface-Layer Scheme
    • 3.1.4. PBL Scheme
    • 3.1.5. Scale-Aware Deep and Shallow Convection Schemes
    • 3.1.6. Microphysics Schemes
    • 3.1.7. Radiation Schemes
    • 3.1.8. Gravity Wave Drag
  • 3.2. Using CDEPS in HAFS
    • 3.2.1. Introduction
    • 3.2.2. Obtaining the Code
    • 3.2.3. Data Access
    • 3.2.4. Data Download
    • 3.2.5. Building CDEPS in HAFS
    • 3.2.6. Using CDEPS in the HAFS Workflow
    • 3.2.7. Limitations and Other Considerations
    • 3.2.8. For More Information
    • 3.2.9. Appendix A: HAFS-CDEPS Configuration Options
    • 3.2.10. Appendix B: Considerations for Adding a New Dataset
• 4. Contributor’s Guide
  • 4.1. Introduction to Working with the HAFS Repository in GitHub
    • 4.1.1. Fork the HAFS Repository and Clone the Forked Repository Locally
    • 4.1.2. Create a Feature Branch from the develop Branch
    • 4.1.3. Submit a Pull Request for Inclusion into the Authoritative HAFS Repository
  • 4.2. UFS Repository Code Management Guidance (Draft)
    • 4.2.1. GitFlow
    • 4.2.2. Fork and PR Overview
    • 4.2.3. General Coding Standards
    • 4.2.4. Development and Testing Process
    • 4.2.5. Opening an Issue
    • 4.2.6. Making a Pull Request
    • 4.2.7. Merging
    • 4.2.8. Need Help?
• 5. Reference
  • 5.1. Reference Materials
    • 5.1.1. Guidance Documents
    • 5.1.2. Useful Code Management Related Materials
    • 5.1.3. Useful Resources
  • 5.2. Glossary