FATES Developer’s Guide

This document is intended for reseach scientists and software engineers who are interested in contributing to the FATES code.

Note

This documentation is currently under development.

Table of contents

This document is structured into four major sections:

• How-To
  • Updating FATES within a Host Land Model
  • Commit and Pull Request Protocol
  • Feature branch naming convention
  • Git for newbies
  • How to add a new FATES history variable
  • Testing Protocols
• Overview
  • FATES Style Guide
  • FATES Development workflow
  • Feature branch naming convention
  • Tagging Methodology
  • Tag and Releases
  • Testing FATES with answer changing updates
• Reference
  • Design Document Template
  • ELM-FATES Cross-Gridcell Seed Dispersal Design
  • ELM-FATES Fire Data API Design Document

Development activity planning

For a current list of development activities in progress, please consult the FATES Pull Request Planning and Status board on the FATES github repo. For a list of long term planned activities, including development plans, please see the FATES activity board on the NGEE-Tropics github organization.