1 About the PEcAn Book

This book serves as documentation for the PEcAn Project. It contains descriptions of topics necessary to inform a beginner and advanced user as well as requisite materials for developers. It does not contain low-level descriptions of functions within PEcAn. Our aim for this documentation is to educate you about the PEcAn software, the possibilities of its usage, and the standards,expectations, and core workflows for developers.

1.1 How to Contribute

If you wish to contribute to this book, we greatly welcome it! The same general steps to contributing PEcAn code to the main line can be used to contribute to this book.

1.1.1 Editing the book yourself

  1. Navigate to the main PEcAn github repository: https://github.com/PecanProject/pecan and fork the repository to your github account.

  2. Use git clone on the machine your are using to create a local copy of the repository. General instructions can be found here

  3. Navigate to the book_source directory and edit the page you would like to change using any text editor. Save your files in the R markdown format (.Rmd).
    • If you are adding a new page, you must edit the _bookdown.yml file also and list your page in order for it to be properly indexed by gitbook.
  4. Within the directory book_source diectory, execute make

  5. Use git add changedfile.Rmd to stage your changes and then commit git commit -m "your message" your changes and push (git push) them to your fork.

  6. Create a pull request, using github, with a description of the changes you have made.

1.1.2 Feedback/Comments/Suggestions

We want your ideas, thoughts, comments, and suggestions! This is an open-sourced project so please feel free to reach out to us in the following ways:

Github: https://github.com/PecanProject/pecan Serving as the main hub of communication surrounding PEcAn development, check out the issues section to see what is coming down the pipeline. If there is anything you feel you can contribute to, leave a comment.

Gitter: http://pecanproject.github.io Gitter serves as our day to day mode of communication. Go to our homepage, linked above, and open the “OPEN CHAT” tab at the bottom to see what we are up to. All you need is a github account and you can chat with us about anything project related.

Email: pecanproj[at]gmail.com If you do not wish your communication with the team to be public, send us an email at the address above and we will get back to you as soon as possible.

1.2 How this Book is organized

This book is organized into three main sections:

  1. A user section that is split three ways into a basic user’s guide, advanced web interface guide, and an advanced user guide for using pecan from the command line.

  2. A section dedicated to expaining the core modules contained within the PEcAn workflow.

  3. A developer section meant to serve as a guide to anyone interested in contributing to the project.