.. pygypsy documentation master file, created by
   sphinx-quickstart on Wed Apr 27 17:42:37 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to pygypsy's documentation!
===================================

About
-----

pygypsy is a python implementation of the forest **Growth and Yield Projection
SYstem** [HuangEtAl2009]_.

Its main usage mode is a command line interface; it also has a an API for
programmatic use.

It's benefits over other offerings are:

- easy to simulate multiple plots in one step
- configurable
- performance

`Install pygypsy now with conda or pip
<https://github.com/conda-forge/pygypsy-feedstock#installing-pygypsy>`__ to
simulate the growth of your forests!

CLI User Guide
--------------

.. toctree::
   :maxdepth: 2

   usage

Developer Guide
---------------
.. toctree::
   :maxdepth: 1

   contributing

API
---

.. toctree::
   :maxdepth: 3

   modules


References
----------

.. [HuangEtAl2009] Huang, Meng, Yang (2009). A Growth and Yield Projection System for Natural and Post-Harvest Stands in Alberta. Retrieved from http://www1.agric.gov.ab.ca/$department/deptdocs.nsf/all/formain15784/$file/GYPSY-Natural-PostHarvestStands-Alberta-May21-2009.pdf?OpenElement