SHBAAM

Satellite Hydrology Bits Analysis And Mapping (SHBAAM) is a Python and bash shell toolbox that combines many repetitive pre and post-processing tasks that are common to studying the studying the terrestrial water cycle with satellite data.

Such tasks include the preparation of files corresponding to:

• Terrestrial Water Storage Anomaly using GRACE data
• Soil Moisture Anomaly, Canopy Water Anomaly, and Snow Water Equivalent Anomaly using GLDAS data.
• Groundwater Storage Anomaly using the combination of GRACE and GLDAS.

Installation with Docker

Installing SHBAAM is by far the easiest with Docker. This document was written and tested using Docker Desktop which is available free of charge and can be installed on a wide variety of operating systems. To install it, follow the instructions in the link provided above.

Note that the experienced users may find more up-to-date installation instructions in Dockerfile.

Download SHBAAM

Downloading SHBAAM with Docker can be done using:

$ docker pull chdavid/shbaam

Run SHBAAM

The beauty of Docker is that there is no need to install anymore packages. SHBAAM is ready to go! To run it, just use:

$ docker run --rm -it chdavid/shbaam

Or, if you'd like to run the Jupyter tutorial instead, you should first start with:

$ docker run --rm -it -p 8888:8888 chdavid/shbaam jupyter notebook --ip 0.0.0.0 --no-browser --allow-root

You'll see that two URLs will be suggested, for example:

    Copy and paste one of these URLs:
        http://(0123456789ab or 127.0.0.1):8888/?token=0123456789abcdefghijklmnopqrstuvwxyz0123456789ab

You then just need to extract one of the suggested URLs, and paste it in the address bar of your internet browser. Note that the URLs are randomly generated each time for security reasons. With the example above, you would use: http://127.0.0.1:8888/?token=0123456789abcdefghijklmnopqrstuvwxyz0123456789ab to access the Jupyter dashboard from your internet browser. Finally, click on TUTORIAL.ipynb within the Jupyter dashboard.

Testing with Docker

Testing scripts are currently under development.

Note that the experienced users may find more up-to-date testing instructions in docker.test.yml.

Installation on Ubuntu

This document was written and tested on a machine with a clean image of Ubuntu 16.04.1 Desktop 64-bit installed. The only step to perform after installation of Ubuntu is the following:

$ sudo apt-get update

Note that the experienced users may find more up-to-date installation instructions in .travis.yml.

Download SHBAAM

First, make sure that git is installed:

$ sudo apt-get install --no-install-recommends -y git

Then download SHBAAM:

$ git clone https://github.com/c-h-david/shbaam

Finally, enter the SHBAAM directory:

$ cd shbaam/

Install APT packages

Software packages for the Advanced Packaging Tool (APT) are summarized in requirements.apt and can be installed with apt-get. All packages can be installed using:

$ sudo apt-get install --no-install-recommends -y $(grep -v -E '(^#|^$)' requirements.apt)

Alternatively, one may install the APT packages listed in requirements.apt one by one, for example:

$ sudo apt-get install --no-install-recommends -y python3

Install Python packages

Python packages from the Python Package Index (PyPI) are summarized in requirements.pip and can be installed with pip3. But first, let's make sure that the latest version of pip3 is installed

$ wget https://bootstrap.pypa.io/get-pip.py
$ sudo python3 get-pip.py --no-cache-dir `grep 'pip==' requirements.pip` `grep 'setuptools==' requirements.pip` `grep 'wheel==' requirements.pip`
$ rm get-pip.py

All PyPI packages can now be installed at once using:

$ sudo pip3 install --no-cache-dir -r requirements.pip

Alternatively, one may install the PyPI packages listed in requirements.pip one by one, for example:

$ sudo pip3 install --no-cache-dir numpy==1.16.4

Testing on Ubuntu

Testing scripts are currently under development.

Note that the experienced users may find more up-to-date testing instructions in .travis.yml.