Python API for all things Virtual Watershed
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc/dflow_cas_userguide
examples
scripts
templates
vwpy
.gitignore
.gitmodules
Dockerfile
LICENSE.md
Makefile
README-Docker.md
README.md
__init__.py
default.conf.template
get_dflow_inputs.py
requirements.txt
run_vw_dflow.py
water-ipw-master.zip

README.md

WC-WAVE Adaptors: Tools for watershed modeling and data management

Setup

Welcome to the home for the WC-WAVE adaptors! Here you can clone the source code, raise issues if you'd like to have a feature added or if you run into a bug or other error, and collaborate with us by submitting your own additions or changes.

To install you'll need to first install the NetCDF library with its headers. On OS X you can use homebrew to install the NetCDF-C library

brew tap homebrew/science && brew install netcdf

On Debian/Ubuntu

sudo apt-get install libnetcdf-dev

To use some scripts, you'll also need GDAL installed.

Then,

git clone https://github.com/tri-state-epscor/wcwave_adaptors.git

To install all other dependencies, start up a virtual environment in the wcwave_adaptors directory

virtualenv venv && source venv/bin/activate

In debian/ubuntu before installing the requirements:

sudo apt-get install libncurses-dev (prerequisite for gnureadline)
sudo apt-get install libhdf5-serial-dev (prerequisite for netcdf4)

and install requirements

pip install -r requirements.txt

To deactivate the virtual environment, simply use the deactivate command that the sourced virtual environment provides.

Configuration Files

In order to use functionality like default connections or setting a default bounding box for your metadata, create a personalized version of default.conf.template for yourself. To do this, first make a copy

cp default.conf.template default.conf

DO NOT SYNC default.conf WITH YOUR GIT REPO AS IT WILL CONTAIN YOUR LOGIN INFO.

Next, edit default.conf, put in your personal VW Data Engine user name and password. Edit the biographic info for yourself, and if you like, put a custom bounding box. The values that come with the repository represent a box that tightly includes the three WC-WAVE states, New Mexico, Idaho, and Nevada.

In order to run unittests, copy default.conf to the test folder as test.conf:

cp default.conf wcwave_adaptors/test/test.conf

Usage and contributing

For usage instructions, please see the WC-WAVE documentation.

For developer information including guidelines for contributing, see the wiki.