From 249eb02a407c5727d19b7f34a35fb8d5be52948d Mon Sep 17 00:00:00 2001
From: Bo Yuan <by276@cornell.edu>
Date: Thu, 12 Dec 2024 15:06:06 -0500
Subject: [PATCH] Update README to reflect new model run commands and data
 preparation notes

---
 README.md | 26 ++++++++++++++++----------
 1 file changed, 16 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index c5aadb2..c673f12 100755
--- a/README.md
+++ b/README.md
@@ -48,26 +48,32 @@ conda activate NYgrid-python
 
     - Go to the `examples` folder.
 
-    - Run the model with default parameters:
+    - Run the base year 2018 case:
 
         ```bash
-        python ex_opf_wo_renew.py
+        python 01_opf_2018NewParams_daily.py
         ```
 
-    - Run the model with renewable integration:
+    - Run the future year 2030 with policy scenarios:
 
         ```bash
-        # With future distributed solar integration
-        python ex_opf_w_future_solar.py
+        # 1) 2030BaselineCase
+        python 02_opf_2030BaselineCase_daily.py
 
-        # With offshore wind integration
-        python ex_opf_w_offshore_wind.py
+        # 2) 2030ContractCase
+        python 03_opf_2030ContractCase_daily.py
 
-        # With solar, offshore wind, and building electrification integration
-        python ex_opf_w_renew.py
+        # 3) 2030StateScenario
+        python 04_opf_2030StateScenario_daily.py
         ```
 
-Note: Renewable timeseries data need to be prepared before running the model.
+    - Note: Generation and load properties and profiles need to be prepared before running these cases.
+
+## Data
+
+1. Generation data: See `examples/write_gen_prop_profiles_{case_name}.ipynb`.
+
+2. Load data: See `examples/write_load_profiles_{case_name}.ipynb`.
 
 
 ## See also