Tethys serves as a critical step to link Xanthos (a global hydrologic model) and the Global Change Analysis Model (GCAM). The spatial resolution of GCAM is geopolitical regional scale for energy and economy systems (32 regions), and river basins for the land, agriculture, and water systems (235 water basins). GCAM is often used as a boundary condition and coupled to sectoral models, such as the Community Land Model and Xanthos, which typically operate at finer spatial and temporal scales than GCAM. For example, Xanthos is a globally gridded hydrology model that operates at monthly scale. Resolving such a mismatch in spatial and temporal scales facilitated coupling these models together. It is also helpful for understanding seasonal patterns of water use and acquiring high resolution water use data. The main objective of Tethys is to reconstruct global monthly gridded (0.5 geographic degree) water withdrawal datasets by spatial and temporal downscaling water withdrawal estimates at region/basin and annual scale. As an open-access software, Tethys applies statistical downscaling algorithms, to spatially and temporally downscale water withdrawal data from annual region/basin scale into monthly grid scale. In our study, the water withdrawals are separated into six sectors: irrigation, livestock, domestic, electricity (generation), manufacturing and mining.
Set up Tethys using the following steps:
-
Install Tethys from GitHub using:
python -m pip install git+https://github.com/JGCRI/tethys.git
-
Download the example data using the following in a Python prompt:
import tethys # the directory that you want to download and extract the example data to data_dir = "<my data download location>" # download and unzip the package data to your local machine tethys.get_package_data(data_dir)
-
Setup your configuration file (.ini). Inside the "example" directory that you just downloaded (
data_dir
from step 2 above) there will be two example configuration files:
data_dir
/example_1_3_1/config.inidata_dir
/example_1_3_1/configDemeter.ini Before you can run these examples please find and replace all absolute paths in each of these files from "C:/Z/models/tethysExampleFolders/example_v1_3_1/..." to "data_dir
/example_1_3_1/...".
-
To run Tethys:
import tethys # the path and file name that my example configuration (.ini) file was downloaded to config_file = 'data_dir/example_1_3_1/config.ini' # run Tethys tethys.run_model(config_file=config_file)
Zarrar Khan, Isaac Thompson, & Chris R. Vernon. (2022). JGCRI/tethys: v1.3.1 (v1.3.1). Zenodo. https://doi.org/10.5281/zenodo.6399488
Li, X., Vernon, C.R., Hejazi, M.I., Link, R.P., Huang, Z., Liu, L. and Feng, L., 2018. Tethys โ A Python Package for Spatial and Temporal Downscaling of Global Water Withdrawals. Journal of Open Research Software, 6(1), p.9. DOI: http://doi.org/10.5334/jors.197
For questions, technical support and user contribution, please contact:
Zarrar Khan [email protected] Chris Vernon [email protected]
Example data is available for download at https://zenodo.org/record/6399117/files/example_v1_3_1.zip?download=1.
Once extracted, change the paths in config.ini
to point to the relevant files and directories on your machine.