Skip to content

Commit 8071114

Browse files
authored
Update README.rst
1 parent c1a5656 commit 8071114

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
Welcome to InfeRes: A Python package for inferring reservoir water surfacea area, level and storage volume
1+
Welcome to InfeRes: A Python package for inferring reservoir water surface area, level and storage volume
22
============================================================================================================
33

44
.. image:: https://img.shields.io/pypi/l/sciris.svg
55
:target: https://github.com/ssmahto/InfeRes_test/blob/main/LICENSE
66

77
``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/>`_.
99
It built on top of `GDAL <https://gdal.org/>`_, `Scikit-Learn <https://scikit-learn.org/>`_, `NumPy <https://numpy.org/>`_ and `Matplotlib <https://matplotlib.org/>`_,
1010
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.
1212

1313
Components of InfeRes
1414
---------------------
@@ -28,7 +28,7 @@ Components of InfeRes
2828
Folder structure
2929
---------------------
3030

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.
3232

3333
**NOTE**: Please unzip all compressed folders before running InfeRes. The folder directories and their paths should be as follows after the unzip:
3434

@@ -61,20 +61,20 @@ Installation
6161

6262
- Install all libraries within the built environment (following steps are recommended).
6363

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)
6565
ii) conda install -c conda-forge **rasterio**
6666
iii) conda install -c conda-forge **spyder**
6767
iv) conda install -c conda-forge **earthengine-api**
6868
v) Similarly install all the other libraries
6969

70-
- 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``)
7171

7272
Usage Instructions
7373
---------------------
7474

7575
1. **DataDownload_GEE.py**
7676

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.
7878

7979
Inputs required (variable name):
8080

@@ -85,11 +85,11 @@ Usage Instructions
8585
The data will be downloaded inside *D:/My Drive/Reservoirs/AyunHa/* in two different folders.
8686

8787
- 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/*.
8989

9090
2. **DataDownload_GEE_GoogleColab.py**
9191

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.
9393

9494
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.
9595

@@ -99,7 +99,7 @@ Usage Instructions
9999

100100
- Creating the reservoir isolation raster (binary map of reservoir maximum extent).
101101
- 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.
103103
- Creating a collection of relatively good quality (less cloud cover) satellite images.
104104

105105
Inputs required (variable name):
@@ -129,9 +129,9 @@ Usage Instructions
129129
- Name of the reservoir (res_name) = AyunHa
130130
- Maximum water level in meter (max_wl) = 211
131131

132-
6. **WSA.py**
132+
5. **WSA.py**
133133

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.
135135

136136
Inputs required (variable name):
137137

@@ -146,8 +146,8 @@ How to Run?
146146

147147
**Step 3.** Configure ``main.py``
148148

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**)
151151

152152
**inputs_InfeRes.csv** contains:
153153

0 commit comments

Comments
 (0)