add docs + fix

README.md

@@ -28,35 +28,40 @@ To run the app locally, you'll need to connect it to the `forecast development d
 OCF team members can connect to the `forecast development database` using [these Notion instructions](https://www.notion.so/openclimatefix/Connecting-to-AWS-RDS-bf35b3fbd61f40df9c974c240e042354). Add `DB_URL= (db_url from notion documents)` to a `secrets.toml` file. Follow the instructions in the Notion document to connect to the database v. 
 
 Run app: `cd src && streamlit run main.py`.
-
-## main.py
+## files
+### main.py
 
 `main.py` contains functions for the `home page` of the app, which focuses on MAE for the OCF `Quartz Solar` forecast.
 
-## forecast.py
+### forecast.py
 
 `forecast.py` contains functions for the `forecast page`. The forecast page looks at how well each of OCF's forecast models is performing compared to `PVLive updated` truth values. 
 
-## status.py
+### status.py
 
 `status.py` contains functionality for the `status pagwe` and allows the OCF team to update the forecast status in the database. This is one of the advantages of using an interface like Streamlit, facilitating status updates in a database. 
 
-## auth.py
+### auth.py
 
 `auth.py` contains code for the basic authenticaion that's been put in place. 
 
-## pvsite_forecast.py
+### pvsite_forecast.py
 
 TODO
 
-## site_toolbox.py
+### site_toolbox.py
 
 TODO
 
-## plots/make_pinball_and_exceedance_plots.py
+### plots/make_pinball_and_exceedance_plots.py
 
 Function to make `pinball` and exceedance plots. This shows how good the probabilistic forecasts are doing. 
 
+### plots/ramp_rate.py
+
+Function to make `ramp rate` plots.
+
+
 ## 🛠️ infrastructure
 
 `.github/workflows` contains some CI actions.

src/main.py

@@ -21,7 +21,7 @@
 )
 from plots.mae_and_rmse import make_rmse_and_mae_plot, make_mae_plot
 from plots.pinball_and_exceedance_plots import make_pinball_or_exceedance_plot
-from plots.ramprate import make_ramp_rate_plot
+from plots.ramp_rate import make_ramp_rate_plot
 from plots.utils import get_x_y
 from pvsite_forecast import pvsite_forecast_page
 from sites_toolbox import sites_toolbox_page

tests/plots/test_ramp_rate.py

@@ -1,4 +1,4 @@
-from plots.ramprate import make_ramp_rate_plot
+from plots.ramp_rate import make_ramp_rate_plot
 
 from datetime import datetime