From c6fa149d176f11d485d542cc3082831723914c60 Mon Sep 17 00:00:00 2001 From: Ishaan Ambrish Date: Thu, 12 Dec 2024 14:26:57 -0800 Subject: [PATCH] added hydroframe commands --- mkdocs/docs/commands.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/mkdocs/docs/commands.md b/mkdocs/docs/commands.md index 66e37ac..f222ef7 100644 --- a/mkdocs/docs/commands.md +++ b/mkdocs/docs/commands.md @@ -34,3 +34,11 @@ This page lists all avilable functions. For example usage, please see the [Tutor * `plot_reservoir(self, columns, title)` - Create interactive timeseries plot for reservoir data - columns: list of columns to plot. If none, it will default to all numeric columns except "Date" - title: custom title for the plot + +### Hydroframe +* `hydroframe.reservoirs` - get dictionary of reservoirs currently in hydroframe + * `['reservoir_name'].plot()` - generate time series plot for selected reservoir in hydroframe +* `hydroframe.reservoir_gdf` - get static reservoir data in GeoDataFrame + * `.explore()` - generate interactive map with reservoir data +* `hydroframe.reservoir_rawData` - get complete reservoir data +