glory-reservoir

The GLObal Reservoir Yield (GLORY) model identifies reservoir storage capacity - yield - cost relationships and provides renewable water cost curves for GCAM

https://github.com/jgcri/glory

Science Score: 75.0%

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

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
    Organization jgcri has institutional domain (www.pnnl.gov)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.8%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

The GLObal Reservoir Yield (GLORY) model identifies reservoir storage capacity - yield - cost relationships and provides renewable water cost curves for GCAM

Basic Info
Statistics
  • Stars: 2
  • Watchers: 5
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Created over 2 years ago · Last pushed almost 2 years ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

build docs tests codecov DOI

Introduction

The GLORY (GLObal Reservoir Yield) model is an open-source Python package designed to optimize water yield for a given reservoir storage capacity while also estimating the economic value of reservoir water supply for global river basins. The GLORY model streamlines workflows by integrating information on climate, hydrology, water demand, reservoir exploitable potential, and physiography to estimate the water availability and prices of water supply from reservoirs. GLORY identifies the sub-annual regulation capability and associated investment of reservoirs and establishes boundary conditions for basin-level analysis on reservoir management.


https://jgcri.github.io/glory/

Citation

Zhao, M., Wild, T.B., Vernon, C., 2024. GLORY: a python package for global reservoir water yield and cost estimation. (In progress) Journal of Open Source Software, DOI: XXXX

Related Publications

Zhao, M., Wild, T. B., Graham, N. T., Kim, S., Binsted, M., Chowdhury, A. F. M. K., Msangi, S., Patel, P. L., Vernon, C. R., Niazi, H., Li, H.-Y., and Abeshu, G. W.: GCAM-GLORY v1.0: Representing Global Reservoir Water Storage in a Multisector Human-Earth System Model, Geosci. Model Dev. Discuss. [preprint], https://doi.org/10.5194/gmd-2023-204, in review, 2023.

Owner

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

Advancing fundamental understanding of human and Earth systems

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Zhao"
  given-names: "Mengqi"
  orcid: "https://orcid.org/0000-0001-5385-2758"
- family-names: "Wild"
  given-names: "Thomas B."
  orcid: "https://orcid.org/0000-0002-6045-7729"
- family-names: "Vernon"
  given-names: "Chris R."
  orcid: "https://orcid.org/0000-0002-3406-6214"
title: "GLORY: a Python package for global reservoir water yield and cost estimation"
version: 1.0.0
url: "https://github.com/JGCRI/glory"
preferred-citation:
    type: article
    authors:
    - family-names: "Zhao"
      given-names: "Mengqi"
      orcid: "https://orcid.org/0000-0001-5385-2758"
    - family-names: "Wild"
      given-names: "Thomas B."
      orcid: "https://orcid.org/0000-0002-6045-7729"
    - family-names: "Vernon"
      given-names: "Chris R."
      orcid: "https://orcid.org/0000-0002-3406-6214"
    doi: "10.xxxxx/joss.xxxxx"
    journal: "Journal of Open Source Software"
    title: "GLORY: a Python package for global reservoir water yield and cost estimation"
    issue: x
    volume: y
    year: 2024

GitHub Events

Total
Last Year

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 19 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 1
  • Total maintainers: 2
pypi.org: glory-reservoir

A python package for estimating global reservoir yield and costs for water supply.

  • Documentation: https://jgcri.github.io/glory
  • License: GLORY BSD 3-Clause License Copyright © 2023, Battelle Memorial Institute All rights reserved. Battelle Memorial Institute (hereinafter Battelle) hereby grants permission to any person or entity lawfully obtaining a copy of this software and associated documentation files (hereinafter “the Software”) to redistribute and use the Software in source and binary forms, with or without modification. Such person or entity may use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and may permit others to do so, subject to the following conditions: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  • Latest release: 0.1.0
    published almost 2 years ago
  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 19 Last month
Rankings
Dependent packages count: 10.7%
Downloads: 20.7%
Average: 30.4%
Dependent repos count: 60.0%
Maintainers (2)
Last synced: 11 months ago

Dependencies

.github/workflows/build.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
.github/workflows/docs.yml actions
  • JamesIves/github-pages-deploy-action 4.1.4 composite
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
.github/workflows/draft-pdf.yml actions
  • actions/checkout v2 composite
  • actions/upload-artifact v1 composite
  • openjournals/openjournals-draft-action master composite
.github/workflows/test.yml actions
  • actions/checkout v4 composite
  • codecov/codecov-action v3 composite
  • conda-incubator/setup-miniconda v3 composite
etc/requirements-test.txt pypi
  • PyYAML >=6 test
  • matplotlib * test
  • numpy >=1.23 test
  • pandas >=1.5 test
  • pyomo * test
  • pytest * test
  • pytest-cov * test
  • requests * test
  • scipy * test
etc/environment.yml conda
  • anaconda-client
  • glpk
  • pip
pyproject.toml pypi
  • PyYAML >=5.4.1
  • matplotlib >=3.7.2
  • numpy >=1.23,<2
  • pandas >=1.5
  • pyomo >=6.6.2
  • requests >=2.25.1
  • scipy >=1.11.2
  • toml >=0.10.2