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 to simulate the growth of your forests!

CLI User Guide

• Data Management
• Configuration
  • Growing Plots
  • Developing Yield Curves
  • Backwards simulation
• Simulations
  • Preparing plot data
  • Running simulation
• Troubleshooting

Developer Guide

• Getting Started
• Development Process Overview
• docker-compose
• Tests
• Linting
• Documentation
• Commit hooks
• Profiling
• Cython and Compiling Extensions
• Ad-hoc analyses in notebooks/
• Environment variables in env/dev.env
• Security Considerations
• Release Process

API

• pygypsy
  • pygypsy package
    • Subpackages
    • Submodules
    • pygypsy.GYPSYNonSpatial module
    • pygypsy.asaCompileAgeGivenSpSiHt module
    • pygypsy.basal_area_factor module
    • pygypsy.basal_area_increment module
    • pygypsy.basal_area_simulate module
    • pygypsy.data_prep module
    • pygypsy.density module
    • pygypsy.forward_simulation module
    • pygypsy.io module
    • pygypsy.log module
    • pygypsy.path module
    • pygypsy.plot module
    • pygypsy.site_index module
    • pygypsy.stand_density_factor module
    • pygypsy.utils module
    • pygypsy.volume module
    • Module contents

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