Skip to content

Commit 5de72a1

Browse files
Update README.rst
1 parent 1f0c9ca commit 5de72a1

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,25 @@ and other popular python packages. ``InfeRes`` is developed with a novel algorit
1212

1313
The InfeRes workflow is fully modularized, with scripts organized by function:
1414

15-
1- main.py: Central orchestration script for running the full InfeRes pipeline over multiple reservoirs.
15+
1- ``main.py``: Central orchestration script for running the full InfeRes pipeline over multiple reservoirs.
1616

17-
2- utils.py: Generic helper functions for raster operations, coordinate transformations, and basic math.
17+
2- ``utils.py``: Generic helper functions for raster operations, coordinate transformations, and basic math.
1818

19-
3- metadata_builder.py: Generates geospatial metadata from the GRanD database for input preparation.
19+
3- ``metadata_builder.py``: Generates geospatial metadata from the GRanD database for input preparation.
2020

21-
4- download_baselayers.py: Downloads foundational datasets (e.g., DEM, GSW frequency, and maximum extent layers) from Google Earth Engine.
21+
4- ``download_baselayers.py``: Downloads foundational datasets (e.g., DEM, GSW frequency, and maximum extent layers) from Google Earth Engine.
2222

23-
5- reservoir_delineation.py: Identifies reservoir extents based on DEMs and frequency maps.
23+
5- ``reservoir_delineation.py``: Identifies reservoir extents based on DEMs and frequency maps.
2424

25-
6- reservoir_curve.py: Builds hypsometric curves from DEM data and reference curves (e.g., GRDL dataset).
25+
6- ``reservoir_curve.py``: Builds hypsometric curves from DEM data and reference curves (e.g., GRDL dataset).
2626

27-
7- satellite_composite.py: Constructs Landsat and Sentinel-based NDWI composites over specified periods and regions.
27+
7- ``satellite_composite.py``: Constructs Landsat and Sentinel-based NDWI composites over specified periods and regions.
2828

29-
8- ndwi_processing.py: Preprocesses Landsat and Sentinel imagery, including NDWI calculation and cloud masking.
29+
8- ``ndwi_processing.py``: Preprocesses Landsat and Sentinel imagery, including NDWI calculation and cloud masking.
3030

31-
9- satellite_water_area.py: Extracts water surface area from satellite NDWI using filtering and clustering methods.
31+
9- ``satellite_water_area.py``: Extracts water surface area from satellite NDWI using filtering and clustering methods.
3232

33-
10- area_to_storage.py: Converts surface water area estimates into elevation and storage (volume) using reservoir hypsometric curve.
33+
10- ``area_to_storage.py``: Converts surface water area estimates into elevation and storage (volume) using reservoir hypsometric curve.
3434

3535

3636
Dependencies
@@ -54,9 +54,9 @@ Acknowledgement
5454

5555
We have acquired the reference GRAND_Curves (reservoir's reconstructed bathymetry) form `Hao et al., (2024) <https://agupubs.onlinelibrary.wiley.com/doi/full/10.1029/2023WR035781>`_, which is available for the list of reservoirs in the Global Reservoir and Dam (GRanD) Database (`Lehner et al., 2011 <https://esajournals.onlinelibrary.wiley.com/doi/10.1890/100125>`_).
5656

57-
- Hao, Z., Chen, F., Jia, X., Cai, X., Yang, C., Du, Y., & Ling, F. (2024). GRDL: A New Global Reservoir Area‐Storage‐Depth Data Set Derived Through Deep Learning‐Based Bathymetry Reconstruction. Water Resources Research, 60(1), e2023WR035781.
57+
- Hao, Z., Chen, F., Jia, X., Cai, X., Yang, C., Du, Y., & Ling, F. (2024). GRDL: A New Global Reservoir Area‐Storage‐Depth Data Set Derived Through Deep Learning‐Based Bathymetry Reconstruction. Water Resources Research, 60(1), e2023WR035781.
5858

59-
- Lehner, B., C. Reidy Liermann, C. Revenga, C. Vörösmarty, B. Fekete, P. Crouzet, P. Döll, M. Endejan, K. Frenken, J. Magome, C. Nilsson, J.C. Robertson, R. Rodel, N. Sindorf, and D. Wisser. 2011. High-resolution mapping of the world’s reservoirs and dams for sustainable river-flow management. Frontiers in Ecology and the Environment 9 (9): 494-502.
59+
- Lehner, B., C. Reidy Liermann, C. Revenga, C. Vörösmarty, B. Fekete, P. Crouzet, P. Döll, M. Endejan, K. Frenken, J. Magome, C. Nilsson, J.C. Robertson, R. Rodel, N. Sindorf, and D. Wisser. 2011. High-resolution mapping of the world’s reservoirs and dams for sustainable river-flow management. Frontiers in Ecology and the Environment 9 (9): 494-502.
6060

6161

6262

0 commit comments

Comments
 (0)