xanthos

An extensible global hydrologic framework

https://github.com/JGCRI/xanthos

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 18 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    5 of 8 committers (62.5%) from academic institutions
  • Institutional organization owner
    Organization jgcri has institutional domain (www.pnnl.gov)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.2%) to scientific vocabulary

Keywords

climate hydrology simulation

Keywords from Contributors

gcam gcims
Last synced: 6 months ago · JSON representation

Repository

An extensible global hydrologic framework

Basic Info
  • Host: GitHub
  • Owner: JGCRI
  • License: other
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 252 MB
Statistics
  • Stars: 37
  • Watchers: 10
  • Forks: 16
  • Open Issues: 18
  • Releases: 7
Topics
climate hydrology simulation
Created almost 9 years ago · Last pushed over 1 year ago
Metadata Files
Readme License

README.md

DOI

Xanthos

Xanthos is an open-source hydrologic model, written in Python, designed to quantify and analyze global water availability. Xanthos simulates historical and future global water availability on a monthly time step at a spatial resolution of 0.5 geographic degrees. Xanthos was designed to be extensible and used by scientists that study global water supply and work with the Global Change Analysis Model (GCAM). Xanthos uses a user-defined configuration file to specify model inputs, outputs and parameters. Xanthos has been tested using actual global data sets and the model is able to provide historical observations and future estimates of renewable freshwater resources in the form of total runoff, average streamflow, potential evapotranspiration, actual evapotranspiration, accessible water, hydropower potential, and more.

Get Started with Xanthos

Set up Xanthos using the following steps: 1. Install Xanthos

* install released version from PyPi using:
```bash
pip install xanthos
```

* or install the latest version hosted on Github using:
```bash
python -m pip install git+https://github.com/JGCRI/xanthos.git
```
  1. Download the example data using the following in a Python prompt: ```python import xanthos

    the directory that you want to download and extract the example data to

    data_dir = ""

    download and unzip the package data to your local machine

    xanthos.getpackagedata(data_dir) ```

  2. Setup your configuration file (.ini). Examples are located in the "example" directory that you just downloaded. Be sure to change the following variables to represent the local path to your example data: RootDir, TempMinFile, PrecipitationFile.

  3. To run Xanthos:

    ```python import xanthos

    the path and file name that my example configuration (.ini) file was downloaded to

    configfile = '/pmabcd_mrtm.ini'

    run Xanthos

    xanthos.runmodel(configfile) ```

Setting up a Xanthos run

A detailed Wiki set up to describe how to set up a Xanthos run can be viewed here: https://github.com/JGCRI/xanthos/wiki/Tutorial-1:--Setting-up-a-Xanthos-run

Available Modules

A detailed Wiki set up to describe available modules, as well as their associated configuration settings, can be viewed here: https://github.com/JGCRI/xanthos/wiki/Available-modules

Xanthos 2 - Upgrades

With the ability to simulate historical and future global water availability on a monthly time step at a spatial resolution of 0.5 geographic degrees, Xanthos version 1.0 provided a solid foundation for continued advancements in global water dynamics science. The goal of Xanthos version 2 was to build upon previous investments by creating an accessible computing environment where core components of the model (potential evapotranspiration (PET), runoff generation, and river routing) could be interchanged or added to without having to start from scratch. Xanthos 2 utilizes a component-style architecture which enables researchers to quickly incorporate and test cutting-edge research in a stable modeling environment prebuilt with a diagnostics module. Major advancements for Xanthos 2.0 were also achieved by creating a more robust default configuration for the model that is now available to the scientific community. These advancements include the addition of: the Penman-Monteith PET module to capture the impacts of evolving land cover, the ABCD water balance module to account for groundwater recharge and discharge in runoff projections, improved water velocity considerations for the Modified River Transport Model (MRTM) routing module, a built-in differential evolution optimization module to calibrate ABCD parameters to modeled global runoff, and hydropower production assessment and potential capacity modules. The figure below demonstrates the optimization module’s ability to calibrate Xanthos 2 runoff to the complex Variable Infiltration Capacity (VIC) model runoff projections when forced by the same climate data. Xanthos can be calibrated against other land surface models and Earth system models.

Xanthos to VIC

Figure: Xanthos 2.0 performance when calibrated to the VIC model forced by WATCH observational climate data. Each point represents the mean annual runoff for each of the 235 river basins in GCAM.

Contact Us

For questions, technical supporting and user contribution, please contact:

Mengqi Zhao mengqi.zhao@pnnl.gov

Chris Vernon chris.vernon@pnnl.gov

Citations

Vernon, C.R., Hejazi, M.I., Turner, S.W.D., Liu, Y., Braun, C.J., Li, X. and Link, R.P. (2019). A Global Hydrologic Framework to Accelerate Scientific Discovery. Journal of Open Research Software, 7(1), p.1. DOI: https://doi.org/10.5334/jors.245.

Related Publications

  • Abeshu, G. W., Tian, F., Wild, T., Zhao, M., Turner, S., Chowdhury, A. F. M. K., Vernon, C. R., Hu, H., Zhuang, Y., Hejazi, M., and Li, H.-Y. (2023). Enhancing the representation of water management in global hydrological models, Geosci. Model Dev. Discuss. https://doi.org/10.5194/gmd-2023-12.
  • Chowdhury, K., Wessel, J., Wild, T.B., Lamontagne, J., Kanyako, F. (2023). Exploring Sustainable Electricity System Development Pathways in South America’s MERCOSUR Sub-Region. Energy Strategy Reviews. https://doi.org/10.1016/j.esr.2023.101150.
  • Khan, Z., Thompson, I., Vernon, C., Graham, N., Chen, M., Wild, T.B. (2023). A global 0.5° gridded multi-sector monthly water withdrawal dataset for 2015-2100 under alternative futures. Nature Scientific Data. https://doi.org/10.1038/s41597-023-02086-2.
  • Kanyako, F., Baker, E., Lamontagne, J., Turner, S., Wild, T.B. (2022). Seasonality and Trade in Hydro-heavy Electricity Markets: The West Africa Power Pool (WAPP). Applied Energy. DOI: https://doi.org/10.1016/j.apenergy.2022.120214.
  • Birnbaum, A.N., Lamontagne, J.R., Wild, T.B., Dolan, F., Yarlagadda, B. (2022). Drivers of Physical and Economic Water Scarcity in Latin America and the Caribbean. Earth’s Future. DOI: https://doi.org/10.1029/2022EF002764.
  • Liu, Y., Hejazi, M., Li, H., Zhang, X., and Leng, G. (2018). A hydrological emulator for global applications – HE v1.0.0, Geosci. Model Dev., 11, 1077–1092, https://doi.org/10.5194/gmd-11-1077-2018.
  • Turner, S.W., Ng, J.Y. and Galelli, S. (2017). Examining global electricity supply vulnerability to climate change using a high-fidelity hydropower dam model. Science of the Total Environment, 590: 663–675. DOI: https://doi.org/10.1016/j.scitotenv.2017.03.022.
  • Turner, S.W., Hejazi, M., Kim, S.H., Clarke, L., Edmonds, J. (2017). Climate impacts on hydropower and consequences for global electricity supply investment needs. Energy, 141: 2081–2090. DOI: https://doi.org/10.1016/j.energy.2017.11.089.

Owner

  • Name: Joint Global Change Research Institute
  • Login: JGCRI
  • Kind: organization
  • Location: College Park, MD, USA

Advancing fundamental understanding of human and Earth systems

GitHub Events

Total
  • Watch event: 4
  • Fork event: 2
Last Year
  • Watch event: 4
  • Fork event: 2

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 269
  • Total Committers: 8
  • Avg Commits per committer: 33.625
  • Development Distribution Score (DDS): 0.532
Past Year
  • Commits: 5
  • Committers: 1
  • Avg Commits per committer: 5.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Caleb Braun c****n@p****v 126
crvernon c****n@g****m 124
Li X****i@p****v 8
Mengqi Zhao m****z@u****u 5
Robert Link r****k@p****v 3
Khan z****n@p****v 1
Vernon d****0@p****v 1
evanoffPNNL 5****L 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 35
  • Total pull requests: 35
  • Average time to close issues: 4 months
  • Average time to close pull requests: about 2 months
  • Total issue authors: 17
  • Total pull request authors: 7
  • Average comments per issue: 1.71
  • Average comments per pull request: 0.37
  • Merged pull requests: 30
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 2.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • calebbraun (9)
  • crvernon (6)
  • swd-turner (3)
  • yvettelkxii (2)
  • mgaacGitHub (2)
  • rubcalvo (2)
  • rplzzz (1)
  • zarrarkhan (1)
  • atmos-project (1)
  • fidelle (1)
  • tianfuyou (1)
  • codewhite-0 (1)
  • mengqi-z (1)
  • flannerydolan (1)
  • wangshaobobetter (1)
Pull Request Authors
  • calebbraun (18)
  • crvernon (10)
  • rplzzz (3)
  • evanoffPNNL (1)
  • mengqi-z (1)
  • zarrarkhan (1)
  • thurber (1)
Top Labels
Issue Labels
enhancement (2) tests (1) question (1)
Pull Request Labels
enhancement (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 17 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 1
  • Total maintainers: 1
pypi.org: xanthos

A global hydrologic modeling framework

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 17 Last month
  • Docker Downloads: 0
Rankings
Dependent packages count: 7.3%
Forks count: 9.1%
Stargazers count: 11.7%
Average: 19.5%
Dependent repos count: 22.1%
Downloads: 47.2%
Maintainers (1)
Last synced: 6 months ago

Dependencies

requirements.txt pypi
  • configobj >=5.0.6
  • joblib *
  • matplotlib *
  • numpy *
  • pandas *
  • scipy >=1.6
setup.py pypi
  • configobj >=5.0.6
  • joblib *
  • matplotlib *
  • numpy *
  • pandas *
  • scipy >=1.6