Merge pull request #2 from sandialabs/v1.1.0

V1.1.0

Author: dpandit223

…meseries/Regulation UP_timeseries_DA.csv …meseries/Regulation Up_timeseries_DA.csvData/RTS_GMLC/reserves/reserves_timeseries/Regulation UP_timeseries_DA.csv renamed to Data/RTS_GMLC/reserves/reserves_timeseries/Regulation Up_timeseries_DA.csv Data/RTS_GMLC/reserves/reserves_timeseries/Regulation UP_timeseries_DA.csv renamed to Data/RTS_GMLC/reserves/reserves_timeseries/Regulation Up_timeseries_DA.csv

@@ -6,7 +6,7 @@
 
 # **QuESt PCM**: A Production Cost Modeling Tool with High-Fidelity Models of Energy Storage Systems
 
-Current release version: 1.0.0
+Current release version: 1.1.0
 
 ## Table of Contents
 - [Introduction](#intro)
@@ -69,19 +69,19 @@ Ensure an optimization solver is installed on your machine. For best performance
     python -m pip install virtualenv
     ```
 
-2. Create a virtual environment (named `venv`):
+2. Create a virtual environment (named `pcm_venv`):
     ```bash
-    python -m virtualenv venv
+    python -m virtualenv pcm_venv
     ```
 
 3. Activate the virtual environment:
    - On Windows:
      ```bash
-     .\venv\Scripts\activate
+     .\pcm_venv\Scripts\activate
      ```
    - On macOS/Linux:
      ```
-     source <env_name>/bin/activate
+     source pcm_venv/bin/activate
      ```
 
 ### Cloning the Repository and Installing Dependencies
@@ -99,7 +99,7 @@ Ensure an optimization solver is installed on your machine. For best performance
 
 3. Install Dependencies:
     ```bash
-    python -m pip install -r requirements.txt
+    pip install -e .
     ```
 [Back to Top](#top)
 
@@ -113,12 +113,22 @@ The network, generator, reserve, and storage data are all input as .csv files. T
 ### Configure the Input File
 
 Before running the simulation, configure the input yaml file in [Config](config/) directory with the specific simulation parameters. Open the file in a text editor and adjust the parameters according to your requirements. The guidelines for setting up the config files are present in [config_readme](config/config_readme.md).
-### Run the Program
+### Option 1: Run the Program using Command Line
 
-Use the example script to run the simulation. Before running, update the main_data_path and yaml_path variables in the script to point to your desired system. Then, with your virtual environment activated, execute the script from the command line as follows:
+First, make sure that you are in the main project directory. Then, use the `example_script.py` to run the simulation. Before running, update the main_data_path, yaml_path, and result_path variables in the script to point to your desired system. Then, with your virtual environment activated, execute the script from the command line as follows:
 ```
 python example_script.py
 ```
+### Option 2: Run the Program using GUI
+
+From any directory, with your virtual environment activated, run the command:
+```
+quest_pcm
+```
+When the GUI (shown below) opens, first browse to and select the data directory and YAML file. The YAML file can also be edited directly within the GUI to adjust simulation parameters. Once everything is set, click `Run Simulation`. After the simulation finishes, a new button `Open Results Folder` will appear that links to the results directory for that run.
+
+<img src = "Images/GUI.png" width="800" alt="Results" />
+
 ### Analyze the Results
 
 Simulation results are stored in the [Results](Results/) directory. Separate timestamp folders are generated for each simulation run. Some key results from each simulation run include: system generation dispatch, operation costs, ancillary service allocations, and storage dispatch characteristics. Detailed decription of QuESt PCM outputs and file organization are present in the [output_readme](Results/output_readme.md).

Images/GUI.png

@@ -26,7 +26,7 @@ fixed_renewable_types: #Renewables whose output capacity is fixed and not dispat
 # "fixed" = Fixed MW value, "percentage" = Demand percentage of system or zone, "timeseries" = user provided data for each period
 # "fixed and "percentage" are reserve values are extracted from "reserves_default_DA.csv and reserves_default_RT.csv" file and "timeseries" are extracted from from reserves_timeseries folder
 System Reserve: percentage
-Regulation Up: fixed 
+Regulation Up: timeseries 
 Regulation Down: timeseries
 Spinning Reserve: timeseries
 NonSpinning Reserve: None

README.md

@@ -16,5 +16,6 @@
 simulator.create_DA_RT_models()
 simulator.simulate_market() 
 
-result_processor = ResultManager(simulator)
+result_path = "Results/"
+result_processor = ResultManager(simulator, result_path)
 result_processor.export_results()

config/GMLC_config.yaml

@@ -21,6 +21,7 @@ ply==3.11
 Pygments==2.19.2
 pyomo==6.9.4
 pyparsing==3.2.5
+pyside6==6.10.2
 pytest==9.0.2
 python-dateutil==2.9.0.post0
 pytz==2025.2

example_script.py

@@ -0,0 +1,51 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="quest_pcm",  
+    version="1.1.0",
+    description="A production cost modeling tool with enhanced storage models.",
+    author="Dilip Pandit (dpandit@sandia.gov)",
+    packages=find_packages(),
+    include_package_data=True,
+    install_requires=[
+        "colorama==0.4.6",
+        "contourpy==1.3.3",
+        "coramin==0.1.1",
+        "cycler==0.12.1",
+        "et_xmlfile==2.0.0",
+        "fonttools==4.61.1",
+        "iniconfig==2.3.0",
+        "kiwisolver==1.4.9",
+        "matplotlib==3.10.8",
+        "narwhals==2.14.0",
+        "networkx==3.6.1",
+        "numpy==2.3.5",
+        "openpyxl==3.1.5",
+        "packaging==25.0",
+        "pandas==2.3.3",
+        "pillow==12.0.0",
+        "plotly==6.5.0",
+        "pluggy==1.6.0",
+        "ply==3.11",
+        "Pygments==2.19.2",
+        "pyomo==6.9.4",
+        "pyparsing==3.2.5",
+        "pyside6==6.6.2",
+        "pytest==9.0.2",
+        "python-dateutil==2.9.0.post0",
+        "pytz==2025.2",
+        "PyYAML==6.0.3",
+        "rainflow==3.2.0",
+        "scipy==1.16.3",
+        "seaborn==0.13.2",
+        "six==1.17.0",
+        "tzdata==2025.3",
+        "gridx_egret @ git+https://github.com/grid-parity-exchange/Egret.git@c6f4f2c5c18727aabf2c20ce1edae941d2b6f843",
+    ],
+    python_requires=">=3.11",
+    entry_points={
+        "console_scripts": [
+            "quest_PCM=src.__app__:main", 
+        ],
+    },
+)