Merge pull request #720 from k1nshuk/plexos

update PLEXOS and Gurobi documentation.
NREL · Jan 21, 2025 · da7f394 · da7f394
2 parents c4127f7 + 891cef8
commit da7f394
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 18 deletions.
diff --git a/docs/Documentation/Applications/Plexos/index.md b/docs/Documentation/Applications/Plexos/index.md
@@ -11,10 +11,11 @@ Users can run PLEXOS models on NREL's computing clusters. However, users need to
 
 ## Available Modules
 
-| Kestrel         | Swift           | Vermilion |
-|:---------------:|:---------------:|:---------:|
-| plexos/9.000R09 | plexos/9.000R09 ||
-| plexos/9.200R06 ||||
+| Kestrel          | Swift           | Vermilion |
+|:----------------:|:---------------:|:---------:|
+| plexos/9.000R09  | plexos/9.000R09 ||
+| plexos/9.200R06  |||
+| plexos/11.000R01 |||
 
 
 !!! info

diff --git a/docs/Documentation/Applications/Plexos/run_plexos.md b/docs/Documentation/Applications/Plexos/run_plexos.md
@@ -21,7 +21,6 @@ Please follow the [setup instructions](setup_plexos.md) before running the examp
 We will load the requisite modules for running PLEXOS 9.2R06 for this example. Please see the [module compatibility](setup_plexos.md#loading-the-appropriate-modules) chart for loading the correct modules
 
 ```bash
-module load gurobi/10.0.2
 module load plexos/9.200R06
 ```
 
@@ -48,6 +47,9 @@ $PLEXOS/PLEXOS64 -n 5_bus_system_v2.xml -m 2024_yr_15percPV_MT_Gurobi -cu nrelpl
 !!! warning
     Not providing the username and password in batch jobs **WILL** cause your jobs to fail.
 
+!!! note
+    PLEXOS will automatically upgrade or downgrade the XML database to the version you are running at run time. You do not need to do so manually. However, your solution may be different or erroneous.
+
 ## Example Scripts
 
 The example scripts are available [here](https://github.com/NREL/HPC/tree/master/applications/plexos/RunFiles). Please clone the repository to run those examples.
@@ -83,7 +85,6 @@ The basic functionality test is the same as the example run in the section above
     cd /to/you/XML/file/
 
     # Load the requisite modules
-    module load gurobi/10.0.2
     module load plexos/9.200R06
 
     # Finally run the PLEXOS executable

diff --git a/docs/Documentation/Applications/Plexos/setup_plexos.md b/docs/Documentation/Applications/Plexos/setup_plexos.md
@@ -6,16 +6,13 @@ grand_parent: Applications
 
 ## Loading the Appropriate Modules
 
-!!! info
-    A user can only run PLEXOS with Gurobi solvers on the clusters at this time. Please set up your model accordingly.
+PLEXOS XML model files can only run with Gurobi that is pre-packaged with a given PLEXOS version. The most common version combinations you may encounter at NREL are
 
-PLEXOS XML model files can only run with the Gurobi solver specified while creating the models. The most common combinations you may encounter are
-
-| PLEXOS Module   | Gurobi Module |
-|:---------------:|:-------------:|
-| plexos/9.000R09 | gurobi/9.5.1  |
-| plexos/9.200R05 | gurobi/10.0.1 |
-| plexos/9.200R06 | gurobi/10.0.2 |
+| PLEXOS Module    | Gurobi Version |
+|:----------------:|:-------------:|
+| plexos/9.000R09  | 9.5.1  |
+| plexos/9.200R06  | 10.0.2 |
+| plexos/11.000R01 | 11.0.2 |
 
 Please [contact us](https://www.nrel.gov/hpc/contact-us.html) if you encounter any issues or require a newer version.
 
@@ -63,7 +60,7 @@ Before we can run PLEXOS, we need to create a license file on the cluster. For t
       <LicenseServerRequestCount />
     </XmlRegistryRoot>'   > ~/.config/PLEXOS/EE_reg.xml
     ```
-## Optional: Conda environment for PLEXOS with Python and R
+## **Optional**: Conda environment for PLEXOS with Python and R
 
 !!! note
     The following instructions are NOT required for only running PLEXOS. One only needs to load the relevant Gurobi and PLEXOS modules to run a PLEXOS XML database. Users may combine these runs with conda, Julia, or other software simply by loading the relevant modules and activating the appropriate conda and Julia environments.
@@ -167,4 +164,4 @@ install.packages("tidyverse")
 ```
 
 After installing the above, follow the remainder of the installation starting with
-point 4.
+point 4.
diff --git a/docs/Documentation/Applications/gurobi.md b/docs/Documentation/Applications/gurobi.md
@@ -33,7 +33,8 @@ documentation](https://www.gurobi.com/documentation/).
 
 | Kestrel         | Swift           |
 |:---------------:|:---------------:|
-| gurobi/11.0.0   ||
+| gurobi/12.0.0   ||
+| gurobi/11.0.2   ||
 | gurobi/10.0.2   ||
 | gurobi/10.0.1   ||
 | gurobi/9.5.1    | gurobi/9.5.1    |