Skip to content

Commit 2a5f478

Browse files
committed
Improve guidance
1 parent a3d5d33 commit 2a5f478

1 file changed

Lines changed: 52 additions & 3 deletions

File tree

pre-analysis/hydro_analysis.ipynb

Lines changed: 52 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,51 @@
88
"# GRDC Hydro Data Processing and Analysis\n",
99
"\n",
1010
"## Overview\n",
11-
"This notebook processes and analyzes streamflow data from the Global Runoff Data Centre (GRDC) to create a comprehensive dataset of river discharge and runoff. The analysis is particularly useful for hydropower assessment, water resource management, and climate impact studies in Central African regions.\n",
11+
"This notebook processes and analyzes streamflow data from the Global Runoff Data Centre (GRDC) to create a comprehensive dataset of river discharge and runoff. The analysis is particularly useful for hydropower assessment, water resource management, and climate impact studies.\n",
12+
"\n",
13+
"## Setting Up Your Environment\n",
14+
"\n",
15+
"### Installation Instructions\n",
16+
"To run this notebook, you need to set up a Python environment with the required packages. Follow these steps:\n",
17+
"\n",
18+
"1. **Create a virtual environment** (recommended):\n",
19+
" ```bash\n",
20+
" # Using conda\n",
21+
" conda create -n hydro-env python=3.8\n",
22+
" conda activate hydro-env\n",
23+
" ```\n",
24+
"\n",
25+
"2. **Install required packages**:\n",
26+
" ```bash\n",
27+
" # Navigate to the pre-analysis directory\n",
28+
" cd epm/pre-analysis\n",
29+
"\n",
30+
" # Install requirements\n",
31+
" pip install -r requirements_hydro.txt\n",
32+
" ```\n",
33+
"\n",
34+
"3. **Create a Jupyter kernel**:\n",
35+
" ```bash\n",
36+
" python -m ipykernel install --user --name hydro-env --display-name \"Hydro Analysis\"\n",
37+
" ```\n",
38+
"\n",
39+
"4. **Launch Jupyter and select the kernel**:\n",
40+
" ```bash\n",
41+
" jupyter notebook\n",
42+
" ```\n",
43+
" When opening this notebook, select the \"Hydro Analysis\" kernel from the kernel menu.\n",
44+
"\n",
45+
"### Required Packages\n",
46+
"The following packages are required and will be installed from the requirements.txt file:\n",
47+
"- pandas\n",
48+
"- numpy\n",
49+
"- matplotlib\n",
50+
"- geopandas\n",
51+
"- folium\n",
52+
"- xarray\n",
53+
"- branca\n",
54+
"- shapely\n",
55+
"- rapidfuzz\n",
1256
"\n",
1357
"## Required Input Data\n",
1458
"This analysis requires three types of input data, all available from open-source repositories. You must download these datasets separately before running this notebook:\n",
@@ -52,7 +96,12 @@
5296
{
5397
"cell_type": "code",
5498
"id": "3a43cbf66c979286",
55-
"metadata": {},
99+
"metadata": {
100+
"ExecuteTime": {
101+
"end_time": "2025-06-24T06:30:08.274627Z",
102+
"start_time": "2025-06-24T06:30:08.260249Z"
103+
}
104+
},
56105
"source": [
57106
"import os\n",
58107
"import geopandas as gpd\n",
@@ -77,7 +126,7 @@
77126
"from utils import map_grdc_stationbasins_and_subregions\n"
78127
],
79128
"outputs": [],
80-
"execution_count": null
129+
"execution_count": 45
81130
},
82131
{
83132
"cell_type": "markdown",

0 commit comments

Comments
 (0)