Skip to content

Merging 2 commits from Docstrings documentation #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jgallegocalderon merged 3 commits into from
Mar 2, 2026
+12 −10
Merged

Merging 2 commits from Docstrings documentation #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
953675a
Some minor additional changes for the paper
snag427 Mar 2, 2026
d35518b
References
snag427 Mar 2, 2026
6baf821
Correction of version in test_main.yml
snag427 Mar 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/test_main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: 3.8
python-version: '3.10'

- name: Install dependencies
run: |
Expand Down
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,23 +96,23 @@ _Chicago_

```

Mitra, Bhaskar, Gallego-Calderon, Juan F., Elliott, Shiloh N, Mosier, Thomas M, Bastidas Pacheco, Camilo Jose, and USDOE Office of Energy Efficiency and Renewable Energy. Hydrogenerate: Open Source Python Tool To Estimate Hydropower Generation Time-series. Computer software. Version 3.6 or newer. October 19, 2021. https://www.osti.gov//servlets/purl/1829986. doi:https://doi.org/10.11578/dc.20211112.1.
Mitra, Bhaskar, Gallego-Calderon, Juan F., Elliott, Shiloh N, Mosier, Thomas M, Bastidas Pacheco, Camilo Jose, Nag, Soumyadeep, and USDOE Office of Energy Efficiency and Renewable Energy. Hydrogenerate: Open Source Python Tool To Estimate Hydropower Generation Time-series. Computer software. Version 3.6 or newer. October 19, 2021. https://www.osti.gov//servlets/purl/1829986. doi:https://doi.org/10.11578/dc.20211112.1.

```

_APA_

```

Mitra, Bhaskar, Gallego-Calderon, Juan F., Elliott, Shiloh N, Mosier, Thomas M, Bastidas Pacheco, Camilo Jose, & USDOE Office of Energy Efficiency and Renewable Energy. (2021, October 19). Hydrogenerate: Open Source Python Tool To Estimate Hydropower Generation Time-series (Version 3.6 or newer) [Computer software]. https://www.osti.gov//servlets/purl/1829986. https://doi.org/10.11578/dc.20211112.1
Mitra, Bhaskar, Gallego-Calderon, Juan F., Elliott, Shiloh N, Mosier, Thomas M, Bastidas Pacheco, Camilo Jose, Nag, Soumyadeep, & USDOE Office of Energy Efficiency and Renewable Energy. (2021, October 19). Hydrogenerate: Open Source Python Tool To Estimate Hydropower Generation Time-series (Version 3.6 or newer) [Computer software]. https://www.osti.gov//servlets/purl/1829986. https://doi.org/10.11578/dc.20211112.1

```

_MLA_

```

Mitra, Bhaskar, Gallego-Calderon, Juan F., Elliott, Shiloh N, Mosier, Thomas M, Bastidas Pacheco, Camilo Jose, and USDOE Office of Energy Efficiency and Renewable Energy. Hydrogenerate: Open Source Python Tool To Estimate Hydropower Generation Time-series. Computer software. https://www.osti.gov//servlets/purl/1829986. Vers. 3.6 or newer. USDOE Office of Energy Efficiency and Renewable Energy (EERE). 19 Oct. 2021. Web. doi:10.11578/dc.20211112.1.
Mitra, Bhaskar, Gallego-Calderon, Juan F., Elliott, Shiloh N, Mosier, Thomas M, Bastidas Pacheco, Camilo Jose, Nag, Soumyadeep, and USDOE Office of Energy Efficiency and Renewable Energy. Hydrogenerate: Open Source Python Tool To Estimate Hydropower Generation Time-series. Computer software. https://www.osti.gov//servlets/purl/1829986. Vers. 3.6 or newer. USDOE Office of Energy Efficiency and Renewable Energy (EERE). 19 Oct. 2021. Web. doi:10.11578/dc.20211112.1.

```

Expand Down
2 changes: 2 additions & 0 deletions citation.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ authors:
given-names: "Thomas M"
- family-names: "Bastidas Pacheco"
given-names: "Camilo J."
- family-names: "Nag"
given-names: "Soumyadeep"
- given-names: "USDOE Office of Energy Efficiency and Renewable Energy"
title: "Hydrogenerate: Open Source Python Tool To Estimate Hydropower Generation Time-series"
version: 1.0.0
Expand Down
10 changes: 5 additions & 5 deletions paper.bib
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ @techreport{osti_1244193

@misc{EIA_price,
title = {Wholesale Electricity and Natural Gas Market Data},
author = {US Energy Information Administration},
author = {{US Energy Information Administration}},
year = {2025},
url = {https://www.eia.gov/electricity/wholesale/},
urldate = {02/04/2025}
Expand All @@ -30,15 +30,15 @@ @misc{RETSCREEN
@misc{irrigationviz,
title = {irrigationviz},
url = {https://irrigationviz.pnnl.gov/},
author = {Pacific Northwest Natiola Laboratory},
author = {{Pacific Northwest National Laboratory}},
year = {2024},
note = {Accessed on 02-18-2025}
}

@misc{USGS,
title = {dataretrieval (Python): a Python package for discovering and retrieving water data available from U.S. federal hydrologic web services: U.S. Geological Survey software release},
url = {10.5066/P94I5TX3},
author = {U.S. Geological Survey},
author = {USGS},
year = {2024},
note = {Accessed on 02-18-2025}
}
Expand All @@ -62,7 +62,7 @@ @BOOK{HPEH
TITLE = {Hydropower Engineering Handbook},
SUBTITLE = {},
AUTHOR = {Gulliver, John S. and Arndt, Roger E.A.},
YEAR = {1991}, % I looked it up
YEAR = {1991},
PUBLISHER = {McGraw-Hill, Inc.},
}

Expand Down Expand Up @@ -155,7 +155,7 @@ @article{Arefiev

@misc{HG,
title = {Hydrogenerate: Open Source Python Tool To Estimate Hydropower Generation Time-series},
author = {Mitra, Bhaskar and Gallego-Calderon, Juan F. and Elliott, Shiloh N and Mosier, Thomas M and Bastidas Pacheco, Camilo Jose, Nag, Soumyadeep and USDOE Office of Energy Efficiency and Renewable Energy},
author = {Mitra, Bhaskar and Gallego-Calderon, Juan F. and Elliott, Shiloh N and Mosier, Thomas M and Bastidas Pacheco, Camilo Jose and Nag, Soumyadeep and {USDOE Office of Energy Efficiency and Renewable Energy}},
abstractNote = {Hydropower is one of the most mature forms of renewable energy generation. The United States (US) has almost 103 GW of installed, with 80 GW of conventional generation and 23 GW of pumped hydropower [1]. Moreover, the potential for future development on Non-Powered Dams is up to 10 GW. With the US setting its goals to become carbon neutral [2], more renewable energy in the form of hydropower needs to be integrated with the grid. Currently, there are no publicly available tool that can estimate the hydropower potential for existing hydropower dams or other non-powered dams. The HydroGenerate is an open-source python library that has the capability of estimating hydropower generation based on flow rate either provided by the user or received from United States Geological Survey (USGS) water data services. The tool calculates the efficiency as a function of flow based on the turbine type either selected by the user or estimated based on the “head” provided by the user.},
url = {https://www.osti.gov//servlets/purl/1829986},
doi = {10.11578/dc.20211112.1},
Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,5 @@
license='BSD 3-Clause License',
install_requires=REQUIRED,
packages=find_packages(),
python_requires='>=3.8'
python_requires='>=3.10'
)