Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

water volume prediction notebook for LRB - IWMI #574

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

KayathriIWMI
Copy link

about water volume prediction use case

this notebook outlines predicting dam levels and volumes based on water surface area data obtained from DE Africa's Waterbodies product.

about the work

  • a separate folder for Limpopo river basin is created under Use cases
  • the note book give access to already trained model such that the user is required to select the waterbody from DE Africa's water body products and run the script to get the predicted water volume results of selected water body.
  • supplementary data required to run the model is stored with in the folder
  • this note book is tested in sandboox environment on 01-23-2025

@mickwelli
Copy link
Contributor

Hi @KayathriIWMI, I have checked out the volume prediction notebook in the Sandbox, congratulations on a great piece of work. I'm looking forward to getting this into the DE Africa repository.

We'll now enter an iterative process of notebook review before merging the PR. This can often mean we go back and forth maybe 5-10 times with various improvements.

A few points to start with:

  • The PR currently contains >650 files. I think we can simplify the Directory & PR a lot. We could just have a Folder in Use Case called 'Limpopo River Basin' or similar. I then propose the following structure:
    ├── Limpopo River Basin
    │ ├──water_volume_prediction_model.ipynb
    │ ├── data
    │ │ ├── dam_attributes
    │ │ │ ├──dam_attributes.csv
    │ │ ├── DWS
    │ │ │ ├──rating_curve.csv
    │ │ │ ├──daily_volumes.csv
    │ ├── results

(Note that results can & should be empty, users will generate the results themselves. We also don't need to include any .png files or Python libraries in the PR).

I think the notebook should run with the proposed structure according to my tests, pending a few edits (some below), but let me know what you think.

Could you see if you create the proposed or similar Directory in this PR?

  • Could the plots be converted from plotly to matplotlib? This will make them a bit easier to plot within the notebook. I'm happy to help make these edits.
  • The markdown in the notebook is very good, thank you. We will need to add further explanation and background to a few parts, such as introducing the Limpopo DT project in the Background section and describing why this notebook was developed. I can help with this too as we go.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants