Skip to content
/ pynvel Public

Python Wrappers and Command Line Interface for the National Volume Estimation Library.

License

Notifications You must be signed in to change notification settings

tharen/pynvel

Repository files navigation

PyNVEL

A Python package for the National Volume Estimator library.

PyNVEL provides a single class, VolumeCalculator, to abstract the interface with the low level NVEL library functions. PyNVEL uses Cython to accelerate bulk processing of tree data and to interface with the NVEL library.

A command line interface is also included for convenient single tree volume estimation reports and to test various equation and configuration combinations.

National Volume Estimator Library
NVEL source code

Build status

Getting Started

Clone the repository

The NVEL code is included as a Git submodule.

git clone --recurse-submodules https://github.com/tharen/pynvel

or for older version of Git.

git clone https://github.com/tharen/pynvel
cd pynel
git submodule update --init --recursive

Setup the Python Environment

Conda is not specifically required, but is known to work as advertised. Note that the conda-forge channel is prioritized in the environment.yml file.

conda env create -f python\environment.yml

Install Additional Requirements

  • CMake

  • MinGW-w64

    MinGW32 or other MinGW providers will likely work, but have not been tested with recent revisions.

To Build

See build_notes.txt

Usage

Command line interface

$ pynvel --help

Run the unit tests.

$ pynvel run-tests

Report the contents of the configuration file. The configuration is stored as a JSON formatted text file.

$ pynvel configuration>config.json

Get a volume report for tree using the default equations. Species, DBH, and total height are required. Default equations can be changed in the configuration file.

$ pynvel volume --help
$ pynvel volume -sDF -d18 -t120

Any valid NVEL equation identifier can be specified.

$ pynvel volume -eF02FW3W202 -d18 -t120 -f87

Estimate height to specific diameter inside bark along the bole.

$ pynvel stem-ht --help
$ pynvel stem-ht -e F02FW3W202 -f 87 -d 18 -t 120 --stem-dib 10.4

About

Python Wrappers and Command Line Interface for the National Volume Estimation Library.

Resources

License

Stars

Watchers

Forks

Packages

No packages published