You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
``InfeRes`` is a python package that is designed to help automatic extraction of reservoir characteristics (water surface area, level, and storage-volume) time-series by taking leverage
8
-
of the Google Earth Engine data collection (`Landsat series <https://developers.google.com/earth-engine/datasets/catalog/landsat/>`_, `Sentinel-2 <https://developers.google.com/earth-engine/datasets/catalog/sentinel-2/>`_), and high resolition `DEM (30m) <https://www.usgs.gov/centers/eros/science/usgs-eros-archive-digital-elevation-shuttle-radar-topography-mission-srtm-1/>`_.
8
+
of the Google Earth Engine data collection (`Landsat series <https://developers.google.com/earth-engine/datasets/catalog/landsat/>`_, `Sentinel-2 <https://developers.google.com/earth-engine/datasets/catalog/sentinel-2/>`_), and high resolution `DEM (30m) <https://www.usgs.gov/centers/eros/science/usgs-eros-archive-digital-elevation-shuttle-radar-topography-mission-srtm-1/>`_.
9
9
It built on top of `GDAL <https://gdal.org/>`_, `Scikit-Learn <https://scikit-learn.org/>`_, `NumPy <https://numpy.org/>`_ and `Matplotlib <https://matplotlib.org/>`_,
10
10
and other popular python packages. ``InfeRes`` is developed with a novel algorithm which helps inferring reservoir characteristics even from the partially cloudy images.
11
-
``InfeRes`` can be applied to monitor water surface area in any reservoir or waterbody; whereas, storage-volume can be obtained for the large reservoirs (storage >= 0.1m:sup:`3`) listed in the `GRanD <https://www.globaldamwatch.org/directory/>`_ databse.
11
+
``InfeRes`` can be applied to monitor water surface area in any reservoir or waterbody; whereas, storage-volume can be obtained for the large reservoirs (storage >= 0.1m:sup:`3`) listed in the `GRanD <https://www.globaldamwatch.org/directory/>`_ database.
12
12
13
13
Components of InfeRes
14
14
---------------------
@@ -28,7 +28,7 @@ Components of InfeRes
28
28
Folder structure
29
29
---------------------
30
30
31
-
Download **InfeRes package** from GitHub (`link <https://github.com/ssmahto/InfeRes_v0.2/>`_) and unzip it inside any directory. For instance, our InfeRes path is *D:/My Drive/InfeRes_v0.2/*. The another folder 'Reservoirs' (path *D:/My Drive/Reservoirs/*), where your satellite data will be downloaded. We have provided the example data for AyunHa reservoir for a quick setup and testing InfeRes as a casy study.
31
+
Download **InfeRes package** from GitHub (`link <https://github.com/ssmahto/InfeRes_v0.2/>`_) and unzip it inside any directory. For instance, our InfeRes path is *D:/My Drive/InfeRes_v0.2/*. Another folder 'Reservoirs' (path *D:/My Drive/Reservoirs/*), where your satellite data will be downloaded. We have provided the example data for AyunHa reservoir for a quick setup and testing InfeRes as a case study.
32
32
33
33
**NOTE**: Please unzip all compressed folders before running InfeRes. The folder directories and their paths should be as follows after the unzip:
34
34
@@ -61,20 +61,20 @@ Installation
61
61
62
62
- Install all libraries within the built environment (following steps are recommended).
63
63
64
-
i) conda install -c conda-forge **gdal=3.9.0** (assuming 3.9.0 is the latest vesrion of GDAL)
64
+
i) conda install -c conda-forge **gdal=3.9.0** (assuming 3.9.0 is the latest version of GDAL)
- Open spyder and load all the InfeRes modules (i.e ``DataDownload_GEE.py``, ``main.py``, ``CURVE.py``, ``PREPROCESSING.py``, and ``WSA.py``)
70
+
- Open spyder and load all the InfeRes modules (i.e. ``DataDownload_GEE.py``, ``main.py``, ``CURVE.py``, ``PREPROCESSING.py``, and ``WSA.py``)
71
71
72
72
Usage Instructions
73
73
---------------------
74
74
75
75
1. **DataDownload_GEE.py**
76
76
77
-
``DataDownload_GEE.py`` is the first step towards running **InfeRes**. ``DataDownload_GEE.py`` will download the satellite images and store them in the Google Drive. Therefore, make sure you have sufficient space in your cloud storage (Google Drive in this case) before running ``DataDownload_GEE.py``. Please also note that the downloading will take time to finish, which depends on the size of satellite image, downloading speed, and the number of images ordered. Therefore, one should first run ``DataDownload_GEE.py`` standalone, and wait until all the orders are successfullty downloaded before running the other modules of InfeRes.
77
+
``DataDownload_GEE.py`` is the first step towards running **InfeRes**. ``DataDownload_GEE.py`` will download the satellite images and store them in the Google Drive. Therefore, make sure you have sufficient space in your cloud storage (Google Drive in this case) before running ``DataDownload_GEE.py``. Please also note that the downloading will take time to finish, which depends on the size of satellite image, downloading speed, and the number of images ordered. Therefore, one should first run ``DataDownload_GEE.py`` standalone, and wait until all the orders are successfully downloaded before running the other modules of InfeRes.
78
78
79
79
Inputs required (variable name):
80
80
@@ -85,11 +85,11 @@ Usage Instructions
85
85
The data will be downloaded inside *D:/My Drive/Reservoirs/AyunHa/* in two different folders.
86
86
87
87
- Raw satellite data (Normalized Difference Water Index or NDWI in this case) will be at *D:/My Drive/Reservoirs/AyunHa/AyunHa_RawData/*.
88
-
- Supplementry data (DEM, Water frequency, Maximum reservoir extent in this case) will be at *D:/My Drive/Reservoirs/AyunHa/AyunHa_Supporting/*.
88
+
- Supplementary data (DEM, Water frequency, Maximum reservoir extent in this case) will be at *D:/My Drive/Reservoirs/AyunHa/AyunHa_Supporting/*.
89
89
90
90
2. **DataDownload_GEE_GoogleColab.py**
91
91
92
-
``DataDownload_GEE_GoogleColab.py`` is an alternative of ``DataDownload_GEE.py``, which runs of web browser-based python environment such as Google Colab. It also takes the same set of inputs (i.e. Name of the reservoir, Year of commission, and Bounding box). However, in this case the data will be downloaded in next in your Google Drive, so the downloading path will be *D:/My Drive/AyunHa_RawData/* and *D:/My Drive/AyunHa_Supporting/* for raw satellite data and supplementry data, respectively.
92
+
``DataDownload_GEE_GoogleColab.py`` is an alternative of ``DataDownload_GEE.py``, which runs of web browser-based python environment such as Google Colab. It also takes the same set of inputs (i.e. Name of the reservoir, Year of commission, and Bounding box). However, in this case the data will be downloaded in next in your Google Drive, so the downloading path will be *D:/My Drive/AyunHa_RawData/* and *D:/My Drive/AyunHa_Supporting/* for raw satellite data and supplementary data, respectively.
93
93
94
94
Please note that you need to maintain the folder structure as *D:/My Drive/Reservoirs/AyunHa/AyunHa_RawData/* and *D:/My Drive/Reservoirs/AyunHa/AyunHa_Supporting/* before running the InfeRes modules. Therefore, you need to move the data to the correct folder arrangement once the downloading is completed.
95
95
@@ -99,7 +99,7 @@ Usage Instructions
99
99
100
100
- Creating the reservoir isolation raster (binary map of reservoir maximum extent).
101
101
- Creating reservoir isolation for DEM (masked DEM)
102
-
- Reprojecting and resizing (or clipping) the satellite images including DEM, water extent, and frequency rasters.
102
+
- Reprojecting and resizing (or clipping) the satellite images including DEM, water extent, and frequency raster.
103
103
- Creating a collection of relatively good quality (less cloud cover) satellite images.
104
104
105
105
Inputs required (variable name):
@@ -129,9 +129,9 @@ Usage Instructions
129
129
- Name of the reservoir (res_name) = AyunHa
130
130
- Maximum water level in meter (max_wl) = 211
131
131
132
-
6. **WSA.py**
132
+
5. **WSA.py**
133
133
134
-
``WSA.py`` estimates the area and storage time-series from the pre-preocessed time satellite images, which only takes intput as the name of the reservoir.
134
+
``WSA.py`` estimates the area and storage time-series from the pre-processed time satellite images, which only takes input as the name of the reservoir.
135
135
136
136
Inputs required (variable name):
137
137
@@ -146,8 +146,8 @@ How to Run?
146
146
147
147
**Step 3.** Configure ``main.py``
148
148
149
-
- Modify the path of InfeRes directory (i.e. **parent_directory**)
150
-
- Prepare the input file (i.e. **inputs_InfeRes.csv**)
149
+
- Modify the path of InfeRes directory (i.e. **parent_directory**)
150
+
- Prepare the input file (i.e. **inputs_InfeRes.csv**)
0 commit comments