BDWS is hosted on github and publically available at https://github.com/konradhafen/beaver-dam-water-storage. The entire repository can be cloned to your machine directly from github, downloaded as a compressed folder, or individual files can be downloaded. Repository directories and files are described below.
- contains the pages for this documentation website
- contains the source code for building documentation website pages with the
- contains data for use in the BDWS tutorials
- source code for the
- source code for the
- example script for usage of BDWS
BDflopy code is in a separate file because it requires use of MODFLOW-2005 and the
Some users may wish to use
To clone the github repository, enter the following from a terminal.
$ cd /path/to/project $ git clone https://github.com/konradhafen/beaver-dam-water-storage
This will create a new directory containing everything in the repository at the location:
The BDWS python code is cross platform (Windows, Mac, Linux), and code for the
BDSWEA packages has been
tested on Windows (10) and Ubuntu (16.04) operating systems.
However, for use of the
BDflopy class Microsoft Windows is recommended as the USGS only provides compiled MODFLOW-2005
executables for this platform. USGS does provide source code that can be compiled on Unix platforms.
Code for the
BDflopy class is cross platform but has only been tested on Windows.
- Python version 2.7.x is recommended.
- Python modules:
- Executable programs:
Python can be installed from a number of sources, including https://www.python.org/downloads/. Anaconda is another option which provides additional tools for python https://www.anaconda.com/download/. This is a recommended option for novice users. Python version 2.7.x is recommended.
Python modules can be installed with
1. Make sure
pip is up-to-date. From a terminal or the Anaconda command prompt enter the following.
>>> pip install --upgrade pip
2. Install any dependencies as follows.
>>> pip install gdal
Full documentation for module dependencies can be found at the following sources.
- gdal http://gdal.org/python/
- numpy https://docs.scipy.org/doc/
- flopy https://modflowpy.github.io/flopydoc
BDflopy class depends on the