MERIT-SWORD is a collection of Python and bash shell scripts that reconciles critical differences between the SWOT River Database (SWORD), the hydrography dataset used to aggregate observations from the Surface Water and Ocean Topography (SWOT) Mission, and MERIT-Basins (MB) an elevation-derived vector hydrography dataset commonly used by global river routing models.
The SWORD and MERIT-Basins river networks differ considerably in their representation of the location and extent of global river reaches, complicating potential synergistic data transfer between SWOT observations and existing hydrologic models.
MERIT-SWORD aims to:
- Identify a subset of river reaches in MERIT-Basins that directly correspond to related reaches in SWORD.
- Generate bidirectional, one-to-many links (i.e. translations) between river reaches in SWORD and MERIT-Basins.
- Provide a reach-specific evaluation of the quality of translations.
The MERIT-SWORD dataset is publicly available at https://zenodo.org/records/13183883.
Installing MERIT-SWORD is by far the easiest with Docker. This document was written and tested using Docker Community Edition which is available for free 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.
Downloading MERIT-SWORD with Docker can be done using:
$ docker pull jswade1/merit-sword
With Docker, there is no need to install anymore packages. MERIT-SWORD is ready to go! To run it, just use:
$ docker run --rm -it jswade1/merit-sword
This document was written and tested on a machine with a clean image of Debian 11.7.0 ARM64 installed, i.e. no upgrade was performed. Similar steps may be applicable for Ubuntu.
Note that the experienced users may find more up-to-date installation instructions in github_actions_CI.yml.
First, update package index files:
$ sudo apt-get update
Then make sure that ca-certificates are installed:
$ sudo apt-get install -y ca-certificates
Then make sure that git is installed:
$ sudo apt-get install -y --no-install-recommends git
Then download MERIT-SWORD:
$ git clone https://github.com/jswade/merit-sword
Finally, enter the MERIT-SWORD directory:
$ cd merit-sword/
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 at once using:
$ sudo apt-get install -y --no-install-recommends $(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 -y --no-install-recommends python3.9
Also make sure that python3 points to python3.9:
$ sudo rm -f /usr/bin/python3
$ sudo ln -s /usr/bin/python3.9 /usr/bin/python3
Python packages from the Python Package Index (PyPI) are summarized in
requirements.pip
and can be installed with pip. But first, let's make sure that the latest
version of pip is installed
$ wget https://bootstrap.pypa.io/pip/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 packages can 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 pandas==2.1.4