Skip to content

Latest commit

 

History

History
139 lines (98 loc) · 5.33 KB

README.rst

File metadata and controls

139 lines (98 loc) · 5.33 KB
Raw

Master: Codeship Status for tesera/gypsy master Dev: Codeship Status for tesera/gypsy dev

Coverage Status Documentation Status PyPI License DOI

Conda-forge

Anaconda-Server Version Anaconda-Server Downloads

Linux: Circle CI OSX: TravisCI Windows: AppVeyor

PyPI

PyPI version PyPI Downloads PyPI Python Versions PyPI Format

pygypsy

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:

  • configurable
  • control over the implementation
  • fast
  • easy to simulate multiple plots
[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

Installation

pygypsy is available in the following package repositories

  1. PyPI
pip install pygypsy
  1. conda-forge
conda config --add channels conda-forge
conda install pygypsy

Conda is the recommended environment for using gypsy on windows. Installation from PyPI currently requires compilation of cython extensions and C code; on Linux and OSX this is rarely problematic.

It is recommended to install in a virtualenv or conda env to avoid clobbering system or other projects' python pacakges.

Usage

pygypsy provides a command line interface for convenient usage

The complete documentation can be accessed with pygypsy -h:

Usage: pygypsy [OPTIONS] COMMAND [ARGS]...

  Growth and Yield Projection System

  Note: 'prep' subcommand must be run before 'simulate'

  Options:
    -v, --verbose
    -o, --output-dir PATH
    -h, --help             Show this message and exit.

  Commands:
    generate_config  Generate a configuration file Generates a...
    plot             Create charts for all files in pygypsy...
    prep             Prepare stand data for use in pygpysy...
    simulate         Run pygypsy simulation

Documentation for subcommands is available via pygypsy SUBCOMMAND -h:

Getting help

If you are interesting in using or developing pygypsy and would like assistance:

  1. Check the pygypsy docs
  2. Check the pygypsy issue tracker
  3. Open a new pygypsy issue

Contributing

If you would like to contribute to pygypsy, start by reviewing the contributing guide. If you need help getting started, see Getting help.