Developer's Guide

This section is geared toward those wishing to contribute to the PEcAn project. We welcome anyone wishing to do so. These are the topics covered in this section:

Contributing, Bug reports, Etc.

• Reporting Bugs and Requesting Features
  • Overview
  • Reporting a bug
  • Requesting a feature
  • Closing an issue
  • When to submit an issue?
• Using Github and Git
  • GIT and GitHub Overview
  • Milestones, Issues, Tasks
  • Quick and Easy
  • Recommended Git Workflow
  • Before any work is done
  • During development
  • Basic Workflow
  • Advanced Workflow: A new branch for each change
  • After pull request is merged
  • Link commits to issues
  • For PEcAn
  • Committing Changes Using Pull Requests
  • Other Useful Git Commands
  • Tags
  • Git + Rstudio
  • Creating a Read-only version
  • For development
  • References
• PEcAn Directory Structure

  Adding or Extending Modules

• Adding Ecosystem Model
  • PEcAn Database
  • Define MODEL_TYPE
  • MACHINE
  • MODEL
  • FORMATS
  • Formats -> Variables
  • MODEL_TYPE -> Formats
  • INPUTS
  • PFTS (Plant Functional Types)
  • Species
  • PRIORS
  • Interface Modules
  • Setting up the module directory (required)
  • DESCRIPTION
  • NAMESPACE
  • Building the package
  • write.config.MODEL (required)
  • Output Conversions
  • met2model.MODEL
  • Commit changes
• Adding an Input Converter
• DART data assimilation

  Advanced Installation

• Installing PEcAn
  • Installing Prerequisites
  • Install models
  • Installing PEcAn
  • Installing BETY
  • Install Database + Data
  • Installing BETYdb Web Application
  • PEcAn Testrun
• PEcAn in the Cloud
• VM Creation
• PEcAn Configuration and Settings Files
  • PEcAn Configuration Files
  • Model-specific configuration files

    R Development

• Coding Style
• Documentation
• Testing
• Package Data
• Logging, Warnings, and Error Messages
• Installing Data
  • Site Information
  • FIA database
  • Flux Camp
  • Harvard for ED tutorial

    Inputs

• Inputs
• Standard Names