1.3_Download_WaPORdata_using_hkvwaporpy.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Example of hkvwaporpy usage\n",
    "First, import neccessary packages: *hkvwaporpy*, *requests*, and *datetime*"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "import hkvwaporpy as hkv\n",
    "import requests\n",
    "import datetime"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## 1. Catalog of datasets/cubes\n",
    "Get the list of datasets in WaPOR database with corresponding codes by using function *get_catalogus()*"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>caption</th>\n",
       "      <th>code</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>Gross Biomass Water Productivity</td>\n",
       "      <td>L1_GBWP_A</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>Net Biomass Water Productivity</td>\n",
       "      <td>L1_NBWP_A</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>Actual EvapoTranspiration and Interception (An...</td>\n",
       "      <td>L1_AETI_A</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>Actual EvapoTranspiration and Interception (De...</td>\n",
       "      <td>L1_AETI_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>Transpiration (Annual)</td>\n",
       "      <td>L1_T_A</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>5</th>\n",
       "      <td>Evaporation (Annual)</td>\n",
       "      <td>L1_E_A</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>6</th>\n",
       "      <td>Interception (Annual)</td>\n",
       "      <td>L1_I_A</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>7</th>\n",
       "      <td>Transpiration (Dekadal)</td>\n",
       "      <td>L1_T_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>8</th>\n",
       "      <td>Evaporation (Dekadal)</td>\n",
       "      <td>L1_E_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>9</th>\n",
       "      <td>Interception (Dekadal)</td>\n",
       "      <td>L1_I_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>10</th>\n",
       "      <td>Net Primary Production</td>\n",
       "      <td>L1_NPP_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>11</th>\n",
       "      <td>Above Ground Biomass Production</td>\n",
       "      <td>L1_AGBP_A</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>12</th>\n",
       "      <td>Land Cover Classification</td>\n",
       "      <td>L1_LCC_A</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>13</th>\n",
       "      <td>Reference EvapoTranspiration (Annual)</td>\n",
       "      <td>L1_RET_A</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>14</th>\n",
       "      <td>Precipitation (Annual)</td>\n",
       "      <td>L1_PCP_A</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>15</th>\n",
       "      <td>Reference EvapoTranspiration (Dekadal)</td>\n",
       "      <td>L1_RET_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>16</th>\n",
       "      <td>Precipitation (Dekadal)</td>\n",
       "      <td>L1_PCP_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>17</th>\n",
       "      <td>Reference EvapoTranspiration (Daily)</td>\n",
       "      <td>L1_RET_E</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>18</th>\n",
       "      <td>Precipitation (Daily)</td>\n",
       "      <td>L1_PCP_E</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>19</th>\n",
       "      <td>Quality Normalized Difference Vegetation Index</td>\n",
       "      <td>L1_QUAL_NDVI_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>20</th>\n",
       "      <td>Quality Land Surface Temperature</td>\n",
       "      <td>L1_QUAL_LST_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>21</th>\n",
       "      <td>Gross Biomass Water Productivity (Seasonal)</td>\n",
       "      <td>L2_GBWP_S</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>22</th>\n",
       "      <td>Net Biomass Water Productivity (Seasonal)</td>\n",
       "      <td>L2_NBWP_S</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>23</th>\n",
       "      <td>Actual EvapoTranspiration and Interception (An...</td>\n",
       "      <td>L2_AETI_A</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>24</th>\n",
       "      <td>Actual EvapoTranspiration and Interception (De...</td>\n",
       "      <td>L2_AETI_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>25</th>\n",
       "      <td>Transpiration (Annual)</td>\n",
       "      <td>L2_T_A</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>26</th>\n",
       "      <td>Evaporation (Annual)</td>\n",
       "      <td>L2_E_A</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>27</th>\n",
       "      <td>Interception (Annual)</td>\n",
       "      <td>L2_I_A</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>28</th>\n",
       "      <td>Transpiration (Dekadal)</td>\n",
       "      <td>L2_T_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>29</th>\n",
       "      <td>Evaporation (Dekadal)</td>\n",
       "      <td>L2_E_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>...</th>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>114</th>\n",
       "      <td>Net Biomass Water Productivity (Seasonal, clip...</td>\n",
       "      <td>L2_NBWP_BAS_S</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>115</th>\n",
       "      <td>Net Biomass Water Productivity (Seasonal, clip...</td>\n",
       "      <td>L2_NBWP_CTY_S</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>116</th>\n",
       "      <td>Actual EvapoTranspiration and Interception (An...</td>\n",
       "      <td>L2_AETI_BAS_A</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>117</th>\n",
       "      <td>Actual EvapoTranspiration and Interception (An...</td>\n",
       "      <td>L2_AETI_CTY_A</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>118</th>\n",
       "      <td>Actual EvapoTranspiration and Interception (De...</td>\n",
       "      <td>L2_AETI_BAS_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>119</th>\n",
       "      <td>Actual EvapoTranspiration and Interception (De...</td>\n",
       "      <td>L2_AETI_CTY_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>120</th>\n",
       "      <td>Transpiration (Annual, clipped by basins)</td>\n",
       "      <td>L2_T_BAS_A</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>121</th>\n",
       "      <td>Transpiration (Annual, clipped by country)</td>\n",
       "      <td>L2_T_CTY_A</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>122</th>\n",
       "      <td>Evaporation (Annual, clipped by basins)</td>\n",
       "      <td>L2_E_BAS_A</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>123</th>\n",
       "      <td>Evaporation (Annual, clipped by country)</td>\n",
       "      <td>L2_E_CTY_A</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>124</th>\n",
       "      <td>Interception (Annual, clipped by basins)</td>\n",
       "      <td>L2_I_BAS_A</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>125</th>\n",
       "      <td>Interception (Annual, clipped by country)</td>\n",
       "      <td>L2_I_CTY_A</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>126</th>\n",
       "      <td>Transpiration (Dekadal, clipped by basins)</td>\n",
       "      <td>L2_T_BAS_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>127</th>\n",
       "      <td>Transpiration (Dekadal, clipped by country)</td>\n",
       "      <td>L2_T_CTY_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>128</th>\n",
       "      <td>Evaporation (Dekadal, clipped by basins)</td>\n",
       "      <td>L2_E_BAS_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>129</th>\n",
       "      <td>Evaporation (Dekadal, clipped by country)</td>\n",
       "      <td>L2_E_CTY_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>130</th>\n",
       "      <td>Interception (Dekadal, clipped by basins)</td>\n",
       "      <td>L2_I_BAS_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>131</th>\n",
       "      <td>Interception (Dekadal, clipped by country)</td>\n",
       "      <td>L2_I_CTY_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>132</th>\n",
       "      <td>Net Primary Production (Dekadal, clipped by ba...</td>\n",
       "      <td>L2_NPP_BAS_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>133</th>\n",
       "      <td>Net Primary Production (Dekadal, clipped by co...</td>\n",
       "      <td>L2_NPP_CTY_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>134</th>\n",
       "      <td>Above Ground Biomass Production (Seasonal, cli...</td>\n",
       "      <td>L2_AGBP_BAS_S</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>135</th>\n",
       "      <td>Above Ground Biomass Production (Seasonal, cli...</td>\n",
       "      <td>L2_AGBP_CTY_S</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>136</th>\n",
       "      <td>Land Cover Classification (Annual, clipped by ...</td>\n",
       "      <td>L2_LCC_BAS_A</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>137</th>\n",
       "      <td>Land Cover Classification (Annual, clipped by ...</td>\n",
       "      <td>L2_LCC_CTY_A</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>138</th>\n",
       "      <td>Phenology (Seasonal, clipped by basins)</td>\n",
       "      <td>L2_PHE_BAS_S</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>139</th>\n",
       "      <td>Phenology (Seasonal, clipped by country)</td>\n",
       "      <td>L2_PHE_CTY_S</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>140</th>\n",
       "      <td>Quality of Normalized Difference Vegetation In...</td>\n",
       "      <td>L2_QUAL_NDVI_BAS_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>141</th>\n",
       "      <td>Quality of Normalized Difference Vegetation In...</td>\n",
       "      <td>L2_QUAL_NDVI_CTY_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>142</th>\n",
       "      <td>Quality Land Surface Temperature (Dekadal, cli...</td>\n",
       "      <td>L2_QUAL_LST_BAS_D</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>143</th>\n",
       "      <td>Quality Land Surface Temperature (Dekadal, cli...</td>\n",
       "      <td>L2_QUAL_LST_CTY_D</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>144 rows × 2 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "                                               caption                code\n",
       "0                     Gross Biomass Water Productivity           L1_GBWP_A\n",
       "1                       Net Biomass Water Productivity           L1_NBWP_A\n",
       "2    Actual EvapoTranspiration and Interception (An...           L1_AETI_A\n",
       "3    Actual EvapoTranspiration and Interception (De...           L1_AETI_D\n",
       "4                               Transpiration (Annual)              L1_T_A\n",
       "5                                 Evaporation (Annual)              L1_E_A\n",
       "6                                Interception (Annual)              L1_I_A\n",
       "7                              Transpiration (Dekadal)              L1_T_D\n",
       "8                                Evaporation (Dekadal)              L1_E_D\n",
       "9                               Interception (Dekadal)              L1_I_D\n",
       "10                              Net Primary Production            L1_NPP_D\n",
       "11                     Above Ground Biomass Production           L1_AGBP_A\n",
       "12                           Land Cover Classification            L1_LCC_A\n",
       "13               Reference EvapoTranspiration (Annual)            L1_RET_A\n",
       "14                              Precipitation (Annual)            L1_PCP_A\n",
       "15              Reference EvapoTranspiration (Dekadal)            L1_RET_D\n",
       "16                             Precipitation (Dekadal)            L1_PCP_D\n",
       "17                Reference EvapoTranspiration (Daily)            L1_RET_E\n",
       "18                               Precipitation (Daily)            L1_PCP_E\n",
       "19      Quality Normalized Difference Vegetation Index      L1_QUAL_NDVI_D\n",
       "20                    Quality Land Surface Temperature       L1_QUAL_LST_D\n",
       "21         Gross Biomass Water Productivity (Seasonal)           L2_GBWP_S\n",
       "22           Net Biomass Water Productivity (Seasonal)           L2_NBWP_S\n",
       "23   Actual EvapoTranspiration and Interception (An...           L2_AETI_A\n",
       "24   Actual EvapoTranspiration and Interception (De...           L2_AETI_D\n",
       "25                              Transpiration (Annual)              L2_T_A\n",
       "26                                Evaporation (Annual)              L2_E_A\n",
       "27                               Interception (Annual)              L2_I_A\n",
       "28                             Transpiration (Dekadal)              L2_T_D\n",
       "29                               Evaporation (Dekadal)              L2_E_D\n",
       "..                                                 ...                 ...\n",
       "114  Net Biomass Water Productivity (Seasonal, clip...       L2_NBWP_BAS_S\n",
       "115  Net Biomass Water Productivity (Seasonal, clip...       L2_NBWP_CTY_S\n",
       "116  Actual EvapoTranspiration and Interception (An...       L2_AETI_BAS_A\n",
       "117  Actual EvapoTranspiration and Interception (An...       L2_AETI_CTY_A\n",
       "118  Actual EvapoTranspiration and Interception (De...       L2_AETI_BAS_D\n",
       "119  Actual EvapoTranspiration and Interception (De...       L2_AETI_CTY_D\n",
       "120          Transpiration (Annual, clipped by basins)          L2_T_BAS_A\n",
       "121         Transpiration (Annual, clipped by country)          L2_T_CTY_A\n",
       "122            Evaporation (Annual, clipped by basins)          L2_E_BAS_A\n",
       "123           Evaporation (Annual, clipped by country)          L2_E_CTY_A\n",
       "124           Interception (Annual, clipped by basins)          L2_I_BAS_A\n",
       "125          Interception (Annual, clipped by country)          L2_I_CTY_A\n",
       "126         Transpiration (Dekadal, clipped by basins)          L2_T_BAS_D\n",
       "127        Transpiration (Dekadal, clipped by country)          L2_T_CTY_D\n",
       "128           Evaporation (Dekadal, clipped by basins)          L2_E_BAS_D\n",
       "129          Evaporation (Dekadal, clipped by country)          L2_E_CTY_D\n",
       "130          Interception (Dekadal, clipped by basins)          L2_I_BAS_D\n",
       "131         Interception (Dekadal, clipped by country)          L2_I_CTY_D\n",
       "132  Net Primary Production (Dekadal, clipped by ba...        L2_NPP_BAS_D\n",
       "133  Net Primary Production (Dekadal, clipped by co...        L2_NPP_CTY_D\n",
       "134  Above Ground Biomass Production (Seasonal, cli...       L2_AGBP_BAS_S\n",
       "135  Above Ground Biomass Production (Seasonal, cli...       L2_AGBP_CTY_S\n",
       "136  Land Cover Classification (Annual, clipped by ...        L2_LCC_BAS_A\n",
       "137  Land Cover Classification (Annual, clipped by ...        L2_LCC_CTY_A\n",
       "138            Phenology (Seasonal, clipped by basins)        L2_PHE_BAS_S\n",
       "139           Phenology (Seasonal, clipped by country)        L2_PHE_CTY_S\n",
       "140  Quality of Normalized Difference Vegetation In...  L2_QUAL_NDVI_BAS_D\n",
       "141  Quality of Normalized Difference Vegetation In...  L2_QUAL_NDVI_CTY_D\n",
       "142  Quality Land Surface Temperature (Dekadal, cli...   L2_QUAL_LST_BAS_D\n",
       "143  Quality Land Surface Temperature (Dekadal, cli...   L2_QUAL_LST_CTY_D\n",
       "\n",
       "[144 rows x 2 columns]"
      ]
     },
     "execution_count": 2,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "df=hkv.read_wapor.get_catalogus()\n",
    "df[['caption','code']]"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## 2. Dataset/Cube info\n",
    "Get dataset/cube information by using function *get_info_cube* with a given cube code\n",
    "For example, the cube code for Level 1 Dekadal Reference EvapoTranspiration is **L1_RET_D**\n",
    "For other dataset, check the code in catalog list."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "metadata": {
    "collapsed": false,
    "scrolled": false
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "                                                                 L1_RET_D\n",
      "temporalExtent                      Dekadal (approximately every 10 days)\n",
      "format                                                     Raster Dataset\n",
      "dataType                                                             Byte\n",
      "spatialReferenceSystem  EPSG:4326 - WGS84 - Geographic Coordinate Syst...\n",
      "spatialExtent                                        Africa and Near East\n",
      "temporalResolution                           from January 2009 to present\n",
      "noDataValue                                                           255\n",
      "methodology             See daily Reference EvapoTranspiration (L1_RET...\n",
      "spatialResolution                        Approximately 20km (0.17 degree)\n",
      "conversionFactor        the pixel value in the downloaded data must be...\n",
      "unit                                                                   mm\n",
      "dimensions              code                                          ...\n",
      "measures                code                                          ...\n"
     ]
    }
   ],
   "source": [
    "ds_code='L1_RET_D' #Cube code for Level 1 Dekadal Reference EvapoTranspiration\n",
    "cube_info=hkv.read_wapor.get_info_cube(cube_code=ds_code)\n",
    "print(cube_info)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "When print cube_info, details of the dataset is shown, such as format,data type, spatial extent, resolution, etc.\n",
    "To see more details from cube_info, use cube_info.loc['**detail**',ds_code].\n",
    "For example, **dimensions** gives information about temporal resolution (time-step) and **measures** gives information about unit and multiplier value to convert Digital number (raw data) to Physical value."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th>code</th>\n",
       "      <th>DEKAD</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>caption</th>\n",
       "      <td>Dekad (10-Days period)</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>code</th>\n",
       "      <td>DEKAD</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>description</th>\n",
       "      <td>Each month is splitted in 3 10-Days periods: f...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>hierarchical</th>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>links</th>\n",
       "      <td>[{u'href': u'https://io.apps.fao.org/gismgr/ap...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>timeSubtype</th>\n",
       "      <td>10-DAYS</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>type</th>\n",
       "      <td>TIME</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>workspaceCode</th>\n",
       "      <td>WAPOR</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>season</th>\n",
       "      <td>NaN</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>stage</th>\n",
       "      <td>NaN</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "code                                                       DEKAD\n",
       "caption                                   Dekad (10-Days period)\n",
       "code                                                       DEKAD\n",
       "description    Each month is splitted in 3 10-Days periods: f...\n",
       "hierarchical                                               False\n",
       "links          [{u'href': u'https://io.apps.fao.org/gismgr/ap...\n",
       "timeSubtype                                              10-DAYS\n",
       "type                                                        TIME\n",
       "workspaceCode                                              WAPOR\n",
       "season                                                       NaN\n",
       "stage                                                        NaN"
      ]
     },
     "execution_count": 4,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "cube_info.loc['dimensions',ds_code]"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th>code</th>\n",
       "      <th>WATER_MM</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>caption</th>\n",
       "      <td>Amount of Water</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>code</th>\n",
       "      <td>WATER_MM</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>description</th>\n",
       "      <td>Amount of water expressed in mm which can be c...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>links</th>\n",
       "      <td>[{u'href': u'https://io.apps.fao.org/gismgr/ap...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>multiplier</th>\n",
       "      <td>0.1</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>scale</th>\n",
       "      <td>3</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>unit</th>\n",
       "      <td>mm</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>workspaceCode</th>\n",
       "      <td>WAPOR</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "code                                                    WATER_MM\n",
       "caption                                          Amount of Water\n",
       "code                                                    WATER_MM\n",
       "description    Amount of water expressed in mm which can be c...\n",
       "links          [{u'href': u'https://io.apps.fao.org/gismgr/ap...\n",
       "multiplier                                                   0.1\n",
       "scale                                                          3\n",
       "unit                                                          mm\n",
       "workspaceCode                                              WAPOR"
      ]
     },
     "execution_count": 5,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "cube_info.loc['measures',ds_code]"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## 3. Data availability and raster ID\n",
    "To get a list of available raster data in the dataset/cube for a period with corresponding raster id, use the function *get_data_availability* with the obtained cube_info. For example, the code below is used to get available Level 1 Dekadal Actual Evapotranspiration and Interception data from 2008-01-01 to 2018-12-31. Here, notice that WaPOR data is only available from 2009."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "data_avail_period: DEKAD\n"
     ]
    },
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>raster_id</th>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>year</th>\n",
       "      <th></th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0901</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0902</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0903</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0904</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0905</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0906</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0907</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0908</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0909</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0910</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0911</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0912</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0913</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0914</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0915</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0916</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0917</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0918</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0919</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0920</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0921</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0922</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0923</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0924</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0925</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0926</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0927</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0928</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0929</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L1_RET_0930</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>...</th>\n",
       "      <td>...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1807</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1808</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1809</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1810</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1811</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1812</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1813</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1814</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1815</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1816</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1817</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1818</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1819</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1820</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1821</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1822</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1823</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1824</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1825</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1826</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1827</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1828</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1829</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1830</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1831</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1832</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1833</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1834</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1835</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2018</th>\n",
       "      <td>L1_RET_1836</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>360 rows × 1 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "        raster_id\n",
       "year             \n",
       "2009  L1_RET_0901\n",
       "2009  L1_RET_0902\n",
       "2009  L1_RET_0903\n",
       "2009  L1_RET_0904\n",
       "2009  L1_RET_0905\n",
       "2009  L1_RET_0906\n",
       "2009  L1_RET_0907\n",
       "2009  L1_RET_0908\n",
       "2009  L1_RET_0909\n",
       "2009  L1_RET_0910\n",
       "2009  L1_RET_0911\n",
       "2009  L1_RET_0912\n",
       "2009  L1_RET_0913\n",
       "2009  L1_RET_0914\n",
       "2009  L1_RET_0915\n",
       "2009  L1_RET_0916\n",
       "2009  L1_RET_0917\n",
       "2009  L1_RET_0918\n",
       "2009  L1_RET_0919\n",
       "2009  L1_RET_0920\n",
       "2009  L1_RET_0921\n",
       "2009  L1_RET_0922\n",
       "2009  L1_RET_0923\n",
       "2009  L1_RET_0924\n",
       "2009  L1_RET_0925\n",
       "2009  L1_RET_0926\n",
       "2009  L1_RET_0927\n",
       "2009  L1_RET_0928\n",
       "2009  L1_RET_0929\n",
       "2009  L1_RET_0930\n",
       "...           ...\n",
       "2018  L1_RET_1807\n",
       "2018  L1_RET_1808\n",
       "2018  L1_RET_1809\n",
       "2018  L1_RET_1810\n",
       "2018  L1_RET_1811\n",
       "2018  L1_RET_1812\n",
       "2018  L1_RET_1813\n",
       "2018  L1_RET_1814\n",
       "2018  L1_RET_1815\n",
       "2018  L1_RET_1816\n",
       "2018  L1_RET_1817\n",
       "2018  L1_RET_1818\n",
       "2018  L1_RET_1819\n",
       "2018  L1_RET_1820\n",
       "2018  L1_RET_1821\n",
       "2018  L1_RET_1822\n",
       "2018  L1_RET_1823\n",
       "2018  L1_RET_1824\n",
       "2018  L1_RET_1825\n",
       "2018  L1_RET_1826\n",
       "2018  L1_RET_1827\n",
       "2018  L1_RET_1828\n",
       "2018  L1_RET_1829\n",
       "2018  L1_RET_1830\n",
       "2018  L1_RET_1831\n",
       "2018  L1_RET_1832\n",
       "2018  L1_RET_1833\n",
       "2018  L1_RET_1834\n",
       "2018  L1_RET_1835\n",
       "2018  L1_RET_1836\n",
       "\n",
       "[360 rows x 1 columns]"
      ]
     },
     "execution_count": 6,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "df_avail=hkv.read_wapor.get_data_availability(cube_info=cube_info,time_range='[2008-01-01,2018-12-31]')\n",
    "df_avail[['raster_id']]"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "In the list of available data *data_avail*, the *raster_id* can be accessed from index number. For example, the first raster with index i=0 has the raster_id **L1_RET_0901**. This id is used later to request download url from database."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 7,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "L1_RET_0901\n"
     ]
    }
   ],
   "source": [
    "i=0 #get the first raster in df_avail\n",
    "cube_period=df_avail.iloc[i]\n",
    "raster_id=cube_period['raster_id']\n",
    "print(raster_id)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## 4. Get download URL \n",
    "To get download url of a raster (or mapset), use the function *get_coverage_url*. This function requires a dataset/cube code, a raster id, and a valid API token, which is obtained from https://wapor.apps.fao.org/profile with a WaPOR account. From the previous results, the ds_code here is **L1_RET_D** and raster_id here is **L1_RET_0901**.\n",
    "The function will return an url to download *download_url* with an expiry time *expiry_datetime*."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 8,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "{'expiry_datetime': datetime.datetime(2019, 7, 5, 16, 40, 27, 830000), 'download_url': u'https://io.apps.fao.org/gismgr/download/db4efb54-3e04-4e08-83f5-2633a2302991/L1_RET_0901.tif'}\n"
     ]
    }
   ],
   "source": [
    "# Get your API Token from https://wapor.apps.fao.org/profile\n",
    "cov_object = hkv.read_wapor.get_coverage_url(\n",
    "    APItoken = '994da2232d83455d110c8e0b08dbf4d86f163e3e63a6cad74326d4e3c510a09781286bc59f4ff7b9', \n",
    "    raster_id = raster_id,\n",
    "    cube_code = ds_code)\n",
    "print(cov_object)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## 5. Download Level 1 raster mapset \n",
    "The obtained url from *get_coverage_url* function can be used to directly download the raster map from the database using *requests.get*. For example, the code below is used to download the raster map *L1_AETI_0901.tif* to the folder *E:\\WaPOR\\L1\\AETI\\D*. To select a different folder to save the data, change the value of the variable *output_folder*."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 9,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "E:\\WaPOR\\L1_RET_D\\L1_RET_0901.tif\n"
     ]
    }
   ],
   "source": [
    "output_folder=r'E:\\WaPOR\\L1_RET_D' #Folder to save data\n",
    "filename=output_folder+'\\{0}.tif'.format(raster_id) #save file with raster id as filename\n",
    "#Download raster file\n",
    "resp=requests.get(cov_object['download_url']) \n",
    "open(filename,'wb').write(resp.content) \n",
    "print(filename)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## 6. Location code\n",
    "WaPOR Level 1 data include raster maps that cover the whole Africa continent and Near East Region. Meanwhile, WaPOR Level 2 data only cover some countries and basins. To download Level 2 data, the location code of the selected country or basin must be defined. The list of location codes can be accessed using function *get_locations()*. Here, if the parameter *L2* of a location has *True* value,it means Level 2 data is available for this location. "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 10,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>name</th>\n",
       "      <th>type</th>\n",
       "      <th>code</th>\n",
       "      <th>L1</th>\n",
       "      <th>L2</th>\n",
       "      <th>L3</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>Awash</td>\n",
       "      <td>BASIN</td>\n",
       "      <td>7010</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>Jordan</td>\n",
       "      <td>BASIN</td>\n",
       "      <td>6006</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>Litani</td>\n",
       "      <td>BASIN</td>\n",
       "      <td>6002</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>Niger</td>\n",
       "      <td>BASIN</td>\n",
       "      <td>7002</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>Nile</td>\n",
       "      <td>BASIN</td>\n",
       "      <td>7003</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>5</th>\n",
       "      <td>Algeria</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>DZA</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>6</th>\n",
       "      <td>Angola</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>AGO</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>7</th>\n",
       "      <td>Bahrain</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>BHR</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>8</th>\n",
       "      <td>Benin</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>BEN</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>9</th>\n",
       "      <td>Botswana</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>BWA</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>10</th>\n",
       "      <td>Burkina Faso</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>BFA</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>11</th>\n",
       "      <td>Burundi</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>BDI</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>12</th>\n",
       "      <td>Cabo Verde</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>CPV</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>13</th>\n",
       "      <td>Cameroon</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>CMR</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>14</th>\n",
       "      <td>Central African Republic</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>CAF</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>15</th>\n",
       "      <td>Chad</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>TCD</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>16</th>\n",
       "      <td>Comoros</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>COM</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>17</th>\n",
       "      <td>Congo</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>COG</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>18</th>\n",
       "      <td>Côte d'Ivoire</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>CIV</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>19</th>\n",
       "      <td>Democratic Republic of the Congo</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>COD</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>20</th>\n",
       "      <td>Djibouti</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>DJI</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>21</th>\n",
       "      <td>Egypt</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>EGY</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>22</th>\n",
       "      <td>Equatorial Guinea</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>GNQ</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>23</th>\n",
       "      <td>Eritrea</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>ERI</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>24</th>\n",
       "      <td>Eswatini</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>SWZ</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>25</th>\n",
       "      <td>Ethiopia</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>ETH</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>26</th>\n",
       "      <td>Gabon</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>GAB</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>27</th>\n",
       "      <td>Gambia</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>GMB</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>28</th>\n",
       "      <td>Ghana</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>GHA</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>29</th>\n",
       "      <td>Guinea</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>GIN</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>...</th>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>44</th>\n",
       "      <td>Mauritania</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>MRT</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>45</th>\n",
       "      <td>Mauritius</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>MUS</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>46</th>\n",
       "      <td>Morocco</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>MAR</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>47</th>\n",
       "      <td>Mozambique</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>MOZ</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>48</th>\n",
       "      <td>Namibia</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>NAM</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>49</th>\n",
       "      <td>Niger</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>NER</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>50</th>\n",
       "      <td>Nigeria</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>NGA</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>51</th>\n",
       "      <td>Occupied Palestinian Territory</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>PSE</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>52</th>\n",
       "      <td>Oman</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>OMN</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>53</th>\n",
       "      <td>Qatar</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>QAT</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>54</th>\n",
       "      <td>Rwanda</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>RWA</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>55</th>\n",
       "      <td>Sao Tome and Principe</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>STP</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>56</th>\n",
       "      <td>Saudi Arabia</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>SAU</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>57</th>\n",
       "      <td>Senegal</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>SEN</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>58</th>\n",
       "      <td>Seychelles</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>SYC</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>59</th>\n",
       "      <td>Sierra Leone</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>SLE</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>60</th>\n",
       "      <td>Somalia</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>SOM</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>61</th>\n",
       "      <td>South Africa</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>ZAF</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>62</th>\n",
       "      <td>South Sudan</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>SSD</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>63</th>\n",
       "      <td>Sudan</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>SDN</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>64</th>\n",
       "      <td>Syrian Arab Republic</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>SYR</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>65</th>\n",
       "      <td>Togo</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>TGO</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>66</th>\n",
       "      <td>Tunisia</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>TUN</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>67</th>\n",
       "      <td>Uganda</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>UGA</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>68</th>\n",
       "      <td>United Arab Emirates</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>ARE</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>69</th>\n",
       "      <td>United Republic of Tanzania</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>TZA</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>70</th>\n",
       "      <td>Western Sahara</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>ESH</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>71</th>\n",
       "      <td>Yemen</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>YEM</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>72</th>\n",
       "      <td>Zambia</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>ZMB</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>73</th>\n",
       "      <td>Zimbabwe</td>\n",
       "      <td>COUNTRY</td>\n",
       "      <td>ZWE</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>74 rows × 6 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "                                name     type  code     L1     L2     L3\n",
       "0                              Awash    BASIN  7010  False   True  False\n",
       "1                             Jordan    BASIN  6006  False   True  False\n",
       "2                             Litani    BASIN  6002  False   True  False\n",
       "3                              Niger    BASIN  7002  False   True  False\n",
       "4                               Nile    BASIN  7003  False   True  False\n",
       "5                            Algeria  COUNTRY   DZA  False  False  False\n",
       "6                             Angola  COUNTRY   AGO  False  False  False\n",
       "7                            Bahrain  COUNTRY   BHR  False  False  False\n",
       "8                              Benin  COUNTRY   BEN  False   True  False\n",
       "9                           Botswana  COUNTRY   BWA  False  False  False\n",
       "10                      Burkina Faso  COUNTRY   BFA  False  False  False\n",
       "11                           Burundi  COUNTRY   BDI  False   True  False\n",
       "12                        Cabo Verde  COUNTRY   CPV  False  False  False\n",
       "13                          Cameroon  COUNTRY   CMR  False  False  False\n",
       "14          Central African Republic  COUNTRY   CAF  False  False  False\n",
       "15                              Chad  COUNTRY   TCD  False  False  False\n",
       "16                           Comoros  COUNTRY   COM  False  False  False\n",
       "17                             Congo  COUNTRY   COG  False  False  False\n",
       "18                     Côte d'Ivoire  COUNTRY   CIV  False  False  False\n",
       "19  Democratic Republic of the Congo  COUNTRY   COD  False  False  False\n",
       "20                          Djibouti  COUNTRY   DJI  False  False  False\n",
       "21                             Egypt  COUNTRY   EGY  False   True  False\n",
       "22                 Equatorial Guinea  COUNTRY   GNQ  False  False  False\n",
       "23                           Eritrea  COUNTRY   ERI  False  False  False\n",
       "24                          Eswatini  COUNTRY   SWZ  False  False  False\n",
       "25                          Ethiopia  COUNTRY   ETH  False   True  False\n",
       "26                             Gabon  COUNTRY   GAB  False  False  False\n",
       "27                            Gambia  COUNTRY   GMB  False  False  False\n",
       "28                             Ghana  COUNTRY   GHA  False   True  False\n",
       "29                            Guinea  COUNTRY   GIN  False  False  False\n",
       "..                               ...      ...   ...    ...    ...    ...\n",
       "44                        Mauritania  COUNTRY   MRT  False  False  False\n",
       "45                         Mauritius  COUNTRY   MUS  False  False  False\n",
       "46                           Morocco  COUNTRY   MAR  False   True  False\n",
       "47                        Mozambique  COUNTRY   MOZ  False   True  False\n",
       "48                           Namibia  COUNTRY   NAM  False  False  False\n",
       "49                             Niger  COUNTRY   NER  False  False  False\n",
       "50                           Nigeria  COUNTRY   NGA  False  False  False\n",
       "51    Occupied Palestinian Territory  COUNTRY   PSE  False   True  False\n",
       "52                              Oman  COUNTRY   OMN  False  False  False\n",
       "53                             Qatar  COUNTRY   QAT  False  False  False\n",
       "54                            Rwanda  COUNTRY   RWA  False   True  False\n",
       "55             Sao Tome and Principe  COUNTRY   STP  False  False  False\n",
       "56                      Saudi Arabia  COUNTRY   SAU  False  False  False\n",
       "57                           Senegal  COUNTRY   SEN  False  False  False\n",
       "58                        Seychelles  COUNTRY   SYC  False  False  False\n",
       "59                      Sierra Leone  COUNTRY   SLE  False  False  False\n",
       "60                           Somalia  COUNTRY   SOM  False  False  False\n",
       "61                      South Africa  COUNTRY   ZAF  False  False  False\n",
       "62                       South Sudan  COUNTRY   SSD  False   True  False\n",
       "63                             Sudan  COUNTRY   SDN  False  False  False\n",
       "64              Syrian Arab Republic  COUNTRY   SYR  False   True  False\n",
       "65                              Togo  COUNTRY   TGO  False  False  False\n",
       "66                           Tunisia  COUNTRY   TUN  False   True  False\n",
       "67                            Uganda  COUNTRY   UGA  False   True  False\n",
       "68              United Arab Emirates  COUNTRY   ARE  False  False  False\n",
       "69       United Republic of Tanzania  COUNTRY   TZA  False  False  False\n",
       "70                    Western Sahara  COUNTRY   ESH  False  False  False\n",
       "71                             Yemen  COUNTRY   YEM  False   True  False\n",
       "72                            Zambia  COUNTRY   ZMB  False  False  False\n",
       "73                          Zimbabwe  COUNTRY   ZWE  False  False  False\n",
       "\n",
       "[74 rows x 6 columns]"
      ]
     },
     "execution_count": 10,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "df_locations = hkv.read_wapor.get_locations()\n",
    "df_locations[['name','type','code','L1','L2','L3']]"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "For example, the location with index number of 0 is Awash basin has Level 2 data available. The location code is **7010**, which can be used to request Level 2 dataset of Awash basin in the next step."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 11,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "(u'BASIN', u'7010', u'Awash')\n"
     ]
    }
   ],
   "source": [
    "location=df_locations.iloc[0]\n",
    "loc_type=location['type']\n",
    "loc_code=location['code']\n",
    "print(loc_type,loc_code,location['name'])"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## 7.  Download Level 2 raster dataset of a location\n",
    "To download Level 2 dataset, the dataset/cube code must be first defined and dataset information must be obtained using the function *get_info_cube*. For example, **L2_AETI_D** is the cube code for Level 2 Dekadal Actual EvapoTranspiration and Interception, as can be found in the catalog from Example 1. "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 12,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "                                                                L2_AETI_D\n",
      "temporalExtent                      Dekadal (approximately every 10 days)\n",
      "format                                                     Raster Dataset\n",
      "dataType                                   Int16 (16bit Unsigned Integer)\n",
      "spatialReferenceSystem  EPSG:4326 - WGS84 - Geographic Coordinate Syst...\n",
      "spatialExtent                                        Africa and Near East\n",
      "temporalResolution                           from January 2009 to present\n",
      "noDataValue                                                         -9999\n",
      "methodology             The calculation of the ETIa is based on the ET...\n",
      "spatialResolution                                  100m (0.000992 degree)\n",
      "conversionFactor        the pixel value in the downloaded data must be...\n",
      "unit                                                                   mm\n",
      "dimensions              code                                          ...\n",
      "measures                code                                          ...\n"
     ]
    }
   ],
   "source": [
    "ds_code='L2_AETI_D'\n",
    "cube_info=hkv.read_wapor.get_info_cube(cube_code=ds_code)\n",
    "print(cube_info)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Using the function *get_data_availability* as in Example 3, the list of available raster map within a period of time can be obtained. For example, the code below is used to get the list of raster id of **L2_AETI_D** in January 2009. To select different time period, change the value of parameter *time_range*."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 13,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "data_avail_period: DEKAD\n"
     ]
    },
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>raster_id</th>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>year</th>\n",
       "      <th></th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L2_AETI_0901</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L2_AETI_0902</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2009</th>\n",
       "      <td>L2_AETI_0903</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "         raster_id\n",
       "year              \n",
       "2009  L2_AETI_0901\n",
       "2009  L2_AETI_0902\n",
       "2009  L2_AETI_0903"
      ]
     },
     "execution_count": 13,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "df_avail=hkv.read_wapor.get_data_availability(cube_info=cube_info,time_range='[2009-01-01,2009-01-31]')\n",
    "df_avail[['raster_id']]"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "With the location code of Awash basin obtained from Example 6, the Level 2 dataset of Ethiopia can be downloaded using the functions *get_coverage_url* and *requests.get*. Notice that in the below code, there are 2 extra parameters of the function *get_coverage_url* required for Level 2 dataset: *loc_type* and *loc_code*. To download all raster mapsets in the list of available data *df_avail*, a for-loop is used to iterate over all *cube_period* in *df_avail*. For each *cube_period*, the *raster_id* is obtained, then *download_url*, and mapset can be download with the url similarly in Example 4 and 5."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 14,
   "metadata": {
    "collapsed": false,
    "scrolled": true
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "https://io.apps.fao.org/gismgr/download/fe67733d-6761-4214-9ef9-d644eb34a3b5/L2_AETI_0901_7010.tif\n",
      "Saved to: E:\\WaPOR\\L2_AETI_D\\L2_AETI_0901.tif\n",
      "https://io.apps.fao.org/gismgr/download/b1a21e47-e929-428a-9696-4f0cc2fd50b8/L2_AETI_0902_7010.tif\n",
      "Saved to: E:\\WaPOR\\L2_AETI_D\\L2_AETI_0902.tif\n",
      "https://io.apps.fao.org/gismgr/download/aee4300f-4e31-4efb-915e-d954bda56709/L2_AETI_0903_7010.tif\n",
      "Saved to: E:\\WaPOR\\L2_AETI_D\\L2_AETI_0903.tif\n"
     ]
    }
   ],
   "source": [
    "output_folder=r'E:\\WaPOR\\L2_AETI_D'\n",
    "for i in range(len(df_avail)):\n",
    "    cube_period = df_avail.iloc[i]\n",
    "    raster_id = cube_period['raster_id']\n",
    "    cov_object = hkv.read_wapor.get_coverage_url(\n",
    "        APItoken='994da2232d83455d110c8e0b08dbf4d86f163e3e63a6cad74326d4e3c510a09781286bc59f4ff7b9',\n",
    "        raster_id = raster_id,\n",
    "        cube_code = ds_code,\n",
    "        loc_type = loc_type,\n",
    "        loc_code = loc_code)\n",
    "    print(cov_object['download_url'])\n",
    "    if cov_object['expiry_datetime']>datetime.datetime.now():\n",
    "        #url still valid\n",
    "        resp = requests.get(cov_object['download_url'])\n",
    "        open(output_folder+'\\{0}.tif'.format(raster_id),'wb').write(resp.content)\n",
    "        print('Saved to: '+output_folder+'\\{0}.tif'.format(raster_id))"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": true
   },
   "source": [
    "## Exercise\n",
    "### Exercise 1 (+)\n",
    "Collect WaPOR Level 1 Daily Precipitation (L1_PCP_E) data for the period 2009-2019\n",
    "### Exercise 2 (+)\n",
    "Collect WaPOR Level 2 data for Awash Basin of a chosen year for the following variables:\n",
    "- Actual EvapoTranspiration and Interception (L2_AETI_D)\n",
    "- Evaporation (L2_E_D)\n",
    "- Transpiration (L2_T_D)\n",
    "- Interception (L2_I_D)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "'''\n",
    "Write your code here\n",
    "'''"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "collapsed": false
   },
   "outputs": [],
   "source": [
    "import hkvwaporpy as hkv\n",
    "import requests\n",
    "import datetime\n",
    "\n",
    "df=hkv.read_wapor.get_catalogus()\n",
    "\n",
    "#%% L1_PCP_E\n",
    "ds_code='L1_PCP_E' \n",
    "cube_info=hkv.read_wapor.get_info_cube(cube_code=ds_code)\n",
    "df_avail=hkv.read_wapor.get_data_availability(cube_info=cube_info,time_range='[2009-01-01,2019-12-31]')\n",
    "\n",
    "output_folder=r'E:\\WaPOR\\L1_PCP_E'\n",
    "for i in range(len(df_avail)):\n",
    "    cube_period = df_avail.iloc[i]\n",
    "    raster_id = cube_period['raster_id']\n",
    "    cov_object = hkv.read_wapor.get_coverage_url(\n",
    "        APItoken='994da2232d83455d110c8e0b08dbf4d86f163e3e63a6cad74326d4e3c510a09781286bc59f4ff7b9',\n",
    "        raster_id = raster_id,\n",
    "        cube_code = ds_code)\n",
    "    print(cov_object['download_url'])\n",
    "    if cov_object['expiry_datetime']>datetime.datetime.now():\n",
    "        #url still valid\n",
    "        resp = requests.get(cov_object['download_url'])\n",
    "        open(output_folder+'\\{0}.tif'.format(raster_id),'wb').write(resp.content)\n",
    "        print('Saved to: '+output_folder+'\\{0}.tif'.format(raster_id))\n",
    "\n",
    "df_locations = hkv.read_wapor.get_locations()\n",
    "location=df_locations.iloc[0]\n",
    "loc_type=location['type']\n",
    "loc_code=location['code']\n",
    "print(loc_type,loc_code,location['name'])\n",
    "\n",
    "#%% L1_RET_D\n",
    "ds_code='L1_RET_D' \n",
    "cube_info=hkv.read_wapor.get_info_cube(cube_code=ds_code)\n",
    "df_avail=hkv.read_wapor.get_data_availability(cube_info=cube_info,time_range='[2009-01-01,2019-12-31]')\n",
    "\n",
    "output_folder=r'E:\\WaPOR\\L1_RET_D'\n",
    "for i in range(len(df_avail)):\n",
    "    cube_period = df_avail.iloc[i]\n",
    "    raster_id = cube_period['raster_id']\n",
    "    cov_object = hkv.read_wapor.get_coverage_url(\n",
    "        APItoken='994da2232d83455d110c8e0b08dbf4d86f163e3e63a6cad74326d4e3c510a09781286bc59f4ff7b9',\n",
    "        raster_id = raster_id,\n",
    "        cube_code = ds_code)\n",
    "    print(cov_object['download_url'])\n",
    "    if cov_object['expiry_datetime']>datetime.datetime.now():\n",
    "        #url still valid\n",
    "        resp = requests.get(cov_object['download_url'])\n",
    "        open(output_folder+'\\{0}.tif'.format(raster_id),'wb').write(resp.content)\n",
    "        print('Saved to: '+output_folder+'\\{0}.tif'.format(raster_id))\n",
    "\n",
    "### Level 2 products\n",
    "\n",
    "df_locations = hkv.read_wapor.get_locations()\n",
    "location=df_locations.iloc[0]\n",
    "loc_type=location['type']\n",
    "loc_code=location['code']\n",
    "print(loc_type,loc_code,location['name'])\n",
    "\n",
    "#%% L2_AETI_D\n",
    "ds_code='L2_AETI_D' \n",
    "cube_info=hkv.read_wapor.get_info_cube(cube_code=ds_code)\n",
    "df_avail=hkv.read_wapor.get_data_availability(cube_info=cube_info,time_range='[2010-01-01,2019-12-31]')\n",
    "\n",
    "output_folder=r'E:\\WaPOR\\L2_AETI_D'\n",
    "for i in range(len(df_avail)):\n",
    "    cube_period = df_avail.iloc[i]\n",
    "    raster_id = cube_period['raster_id']\n",
    "    cov_object = hkv.read_wapor.get_coverage_url(\n",
    "        APItoken='994da2232d83455d110c8e0b08dbf4d86f163e3e63a6cad74326d4e3c510a09781286bc59f4ff7b9',\n",
    "        raster_id = raster_id,\n",
    "        cube_code = ds_code,\n",
    "        loc_type = loc_type,\n",
    "        loc_code = loc_code)\n",
    "    print(cov_object['download_url'])\n",
    "    if cov_object['expiry_datetime']>datetime.datetime.now():\n",
    "        #url still valid\n",
    "        resp = requests.get(cov_object['download_url'])\n",
    "        open(output_folder+'\\{0}.tif'.format(raster_id),'wb').write(resp.content)\n",
    "        print('Saved to: '+output_folder+'\\{0}.tif'.format(raster_id))\n",
    "\n",
    "#%% L2_E_D\n",
    "ds_code='L2_E_D' \n",
    "cube_info=hkv.read_wapor.get_info_cube(cube_code=ds_code)\n",
    "df_avail=hkv.read_wapor.get_data_availability(cube_info=cube_info,time_range='[2010-01-01,2019-12-31]')\n",
    "\n",
    "output_folder=r'E:\\WaPOR\\L2_E_D'\n",
    "for i in range(len(df_avail)):\n",
    "    cube_period = df_avail.iloc[i]\n",
    "    raster_id = cube_period['raster_id']\n",
    "    cov_object = hkv.read_wapor.get_coverage_url(\n",
    "        APItoken='994da2232d83455d110c8e0b08dbf4d86f163e3e63a6cad74326d4e3c510a09781286bc59f4ff7b9',\n",
    "        raster_id = raster_id,\n",
    "        cube_code = ds_code,\n",
    "        loc_type = loc_type,\n",
    "        loc_code = loc_code)\n",
    "    print(cov_object['download_url'])\n",
    "    if cov_object['expiry_datetime']>datetime.datetime.now():\n",
    "        #url still valid\n",
    "        resp = requests.get(cov_object['download_url'])\n",
    "        open(output_folder+'\\{0}.tif'.format(raster_id),'wb').write(resp.content)\n",
    "        print('Saved to: '+output_folder+'\\{0}.tif'.format(raster_id))\n",
    "\n",
    "#%% L2_T_D\n",
    "ds_code='L2_T_D' \n",
    "cube_info=hkv.read_wapor.get_info_cube(cube_code=ds_code)\n",
    "df_avail=hkv.read_wapor.get_data_availability(cube_info=cube_info,time_range='[2010-01-01,2019-12-31]')\n",
    "\n",
    "output_folder=r'E:\\WaPOR\\L2_T_D'\n",
    "for i in range(len(df_avail)):\n",
    "    cube_period = df_avail.iloc[i]\n",
    "    raster_id = cube_period['raster_id']\n",
    "    cov_object = hkv.read_wapor.get_coverage_url(\n",
    "        APItoken='994da2232d83455d110c8e0b08dbf4d86f163e3e63a6cad74326d4e3c510a09781286bc59f4ff7b9',\n",
    "        raster_id = raster_id,\n",
    "        cube_code = ds_code,\n",
    "        loc_type = loc_type,\n",
    "        loc_code = loc_code)\n",
    "    print(cov_object['download_url'])\n",
    "    if cov_object['expiry_datetime']>datetime.datetime.now():\n",
    "        #url still valid\n",
    "        resp = requests.get(cov_object['download_url'])\n",
    "        open(output_folder+'\\{0}.tif'.format(raster_id),'wb').write(resp.content)\n",
    "        print('Saved to: '+output_folder+'\\{0}.tif'.format(raster_id))\n",
    "\n",
    "#%% L2_I_D\n",
    "ds_code='L2_I_D' \n",
    "cube_info=hkv.read_wapor.get_info_cube(cube_code=ds_code)\n",
    "df_avail=hkv.read_wapor.get_data_availability(cube_info=cube_info,time_range='[2010-01-01,2019-12-31]')\n",
    "\n",
    "output_folder=r'E:\\WaPOR\\L2_I_D'\n",
    "for i in range(len(df_avail)):\n",
    "    cube_period = df_avail.iloc[i]\n",
    "    raster_id = cube_period['raster_id']\n",
    "    cov_object = hkv.read_wapor.get_coverage_url(\n",
    "        APItoken='994da2232d83455d110c8e0b08dbf4d86f163e3e63a6cad74326d4e3c510a09781286bc59f4ff7b9',\n",
    "        raster_id = raster_id,\n",
    "        cube_code = ds_code,\n",
    "        loc_type = loc_type,\n",
    "        loc_code = loc_code)\n",
    "    print(cov_object['download_url'])\n",
    "    if cov_object['expiry_datetime']>datetime.datetime.now():\n",
    "        #url still valid\n",
    "        resp = requests.get(cov_object['download_url'])\n",
    "        open(output_folder+'\\{0}.tif'.format(raster_id),'wb').write(resp.content)\n",
    "        print('Saved to: '+output_folder+'\\{0}.tif'.format(raster_id))\n"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 2",
   "language": "python",
   "name": "python2"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 2
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython2",
   "version": "2.7.13"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}