Welcome to the HAFS User’s Guide

• 1. Introduction
• 2. Technical Overview
  • 2.1. Prerequisites for Working with the HAFS Repository
  • 2.2. HAFS GitHub Repository Management
  • 2.3. HAFS Directory Structure
  • 2.4. HAFS Submodules
  • 2.5. HAFS Workflow Schematic
• 3. HAFS Quick Start Guide
  • 3.1. Clone and Checkout the Repository
  • 3.2. Build and Install HAFS
    • 3.2.1. Parts of install_hafs.sh
  • 3.3. Run the HAFS System
    • 3.3.1. Edit system.conf
    • 3.3.2. XML File to Run the Workflow
    • 3.3.3. Edit the Cron Job Driver Script
    • 3.3.4. Run HAFS
• 4. HAFS Extended Quick Start Guide
  • 4.1. Clone and Checkout the Repository
  • 4.2. Build and Install HAFS
    • 4.2.1. Parts of install_hafs.sh
  • 4.3. Run the HAFS System
    • 4.3.1. Edit system.conf
    • 4.3.2. HAFS Physics Configuration
    • 4.3.3. HAFS Nesting Configuration
    • 4.3.4. XML File to Run the Workflow
    • 4.3.5. Edit the Cron Job Driver Script
    • 4.3.6. Run HAFS
• 5. Introduction to Working with the HAFS Repository in GitHub
  • 5.1. Fork the HAFS Repository and Clone the Forked Repository Locally
  • 5.2. Create a Feature Branch from the develop Branch
  • 5.3. Submit a Pull Request for Inclusion into the Authoritative HAFS Repository
• 6. Regression Test
• 7. Using CDEPS in HAFS
  • 7.1. Introduction
  • 7.2. Obtaining the Code
  • 7.3. Data Access
  • 7.4. Data Download
  • 7.5. Building CDEPS in HAFS
  • 7.6. Using CDEPS in the HAFS Workflow
  • 7.7. Limitations and Other Considerations
  • 7.8. For More Information
  • 7.9. Appendix A: HAFS-CDEPS Configuration Options
  • 7.10. Appendix B: Considerations for Adding a New Dataset
• 8. Reference Materials
  • 8.1. Guidance Documents
  • 8.2. Useful Code Management Related Materials
  • 8.3. Useful Resources
• 9. Glossary