From 5a8d106c826eaf86df2b7ec5aa3b1cf633af5bb2 Mon Sep 17 00:00:00 2001 From: Shen Wang <125523842+swang22@users.noreply.github.com> Date: Thu, 7 Dec 2023 00:12:32 -0500 Subject: [PATCH 1/9] Update README.md add windows terminal instruction --- README.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 32b6559..f34bb6e 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ The HOPE model was originally developed by a team of researchers in Prof. [Benja ### Install Julia and clone the HOPE repository 1. Install [Julia](http://julialang.org/) language. 2. Clone or download the **HOPE** repository to your local directory. For example, save the **HOPE** project in your `home` directory:`/yourpath/home/HOPE`. -### Using Visual Studio Code to Run a Case +### Using Visual Studio Code to Run a Case (Recommended) Download [VScode](https://code.visualstudio.com/) and [install](https://code.visualstudio.com/docs/setup/setup-overview) it. 1. Open the VScode, click the 'File' tab, select 'Open Folder...', and navigate to your home path:`/yourpath/home`. 2. In the VScode TERMINAL, type `Julia`. Julia will be opened as below: @@ -34,15 +34,30 @@ Download [VScode](https://code.visualstudio.com/) and [install](https://code.vis 4. Type `instantiate` in the (HOPE) pkg prompt (make sure you are in your `home` directory, not the `home/HOPE` directory!). 5. Type `st` to check that the dependencies (packages that HOPE needs) have been installed. Type `up` to update the version of dependencies (packages). (This step may take some time when you install HOPE for the first time. After the HOPE is successfully installed, you can skip this step) ![image](https://github.com/swang22/HOPE/assets/125523842/1eddf81c-97e4-4334-85ee-44958fcf8c2f) -6. If there is no error in the above processes, the **HOPE** model has been successfully installed. Then, click on `Backspace` to back to the Juila prompt. +6. If there is no error in the above processes, the **HOPE** model has been successfully installed. Then, click on `Backspace` to go back to the Juila prompt. To run an example case (e.g., default Maryland 2035 case in `PCM` mode), type `using HOPE`, and type `HOPE.run_hope("HOPE/ModelCases/MD_Excel_case/")`, you will see the **HOPE** is running: ![image](https://github.com/swang22/HOPE/assets/125523842/33fa4fbc-6109-45ce-ac41-f41a29885525) The results will be saved in `yourpath/home/HOPE/ModelCases/MD_Excel_case/output`. ![image](https://github.com/swang22/HOPE/assets/125523842/7a760912-b8f2-4d5c-aea0-b85b6eb00bf4) +7. After finishing the setup and the first time successful run, you can skip steps 4 and 5 for your future runs. -### Using Command Prompt to Run a Case +### Using System Terminal to Run a Case #### Windows users - +1. Open **Command Prompt** from Windows **Start** and navigate to your home path:`/yourpath/home`. +2. Type `julia`. Julia will be opened as below: +![image](https://github.com/swang22/HOPE/assets/125523842/6c61bed1-bf8e-4186-bea2-22413fd1328e) +3. Type `]` into the Julia package mode, and type `activate HOPE` (if you are in your `home` directory), you will see prompt `(@v1.8)` changing to `(HOPE)`, which means the HOPE project is activated successfully. +4. Type `instantiate` in the (HOPE) pkg prompt. ( After the HOPE is successfully installed, you can skip this step) +5. Type `st` to check that the dependencies (packages that HOPE needs) have been installed. Type `up` to update the version of dependencies (packages). (This step may take some time when you install HOPE for the first time. After the HOPE is successfully installed, you can skip this step) +![image](https://github.com/swang22/HOPE/assets/125523842/66ce1ea1-1b06-43d0-9f2b-542c473797aa) +6. If there is no error in the above processes, the **HOPE** model has been successfully installed. Then, click `Backspace` to return to the Juila prompt. + To run an example case (e.g., default Maryland 2035 case in `PCM` mode), type `using HOPE`, and type `HOPE.run_hope("HOPE/ModelCases/MD_Excel_case/")`, you will see the **HOPE** is running: +![image](https://github.com/swang22/HOPE/assets/125523842/c36c6384-7e04-450d-921a-784c3b13f8bd) +The results will be saved in `yourpath/home/HOPE/ModelCases/MD_Excel_case/output`. +![image](https://github.com/swang22/HOPE/assets/125523842/7a760912-b8f2-4d5c-aea0-b85b6eb00bf4) +7. After finishing the setup and the first time successful run, you can skip steps 4 and 5 for your future runs. +![image](https://github.com/swang22/HOPE/assets/125523842/f2b491bb-d4ca-4dc4-8171-cba05cc10a23) + #### Mac users ## Solvers From 5d2019da7d0bb260204064787e979f350d2028a2 Mon Sep 17 00:00:00 2001 From: Shen Wang <125523842+swang22@users.noreply.github.com> Date: Thu, 7 Dec 2023 00:15:57 -0500 Subject: [PATCH 2/9] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f34bb6e..a65b449 100644 --- a/README.md +++ b/README.md @@ -29,12 +29,12 @@ Download [VScode](https://code.visualstudio.com/) and [install](https://code.vis 1. Open the VScode, click the 'File' tab, select 'Open Folder...', and navigate to your home path:`/yourpath/home`. 2. In the VScode TERMINAL, type `Julia`. Julia will be opened as below: ![image](https://github.com/swang22/HOPE/assets/125523842/5fc3a8c9-23f8-44a3-92ab-135c4dbdc118) -3. Type `]` into the Julia package mode, and type `activate HOPE` (if you are in your `home` directory) or `activate yourpath/home/HOPE` (if you are not in your `home` directory), you will see prompt `(@v1.8)` changing to `(HOPE)`, which means the HOPE project is activated successfully. +3. Type `]` into the Julia package mode, and type `activate HOPE` (if you are in your `home` directory) or `activate yourpath/home/HOPE` (if you are not in your `home` directory), you will see prompt `(@v1.8) pkg>` changing to `(HOPE) pkg>`, which means the HOPE project is activated successfully. ![image](https://github.com/swang22/HOPE/assets/125523842/2a0c259d-060e-4799-a044-8dedb8e5cc4d) 4. Type `instantiate` in the (HOPE) pkg prompt (make sure you are in your `home` directory, not the `home/HOPE` directory!). 5. Type `st` to check that the dependencies (packages that HOPE needs) have been installed. Type `up` to update the version of dependencies (packages). (This step may take some time when you install HOPE for the first time. After the HOPE is successfully installed, you can skip this step) ![image](https://github.com/swang22/HOPE/assets/125523842/1eddf81c-97e4-4334-85ee-44958fcf8c2f) -6. If there is no error in the above processes, the **HOPE** model has been successfully installed. Then, click on `Backspace` to go back to the Juila prompt. +6. If there is no error in the above processes, the **HOPE** model has been successfully installed. Then, click `Backspace` to return to the Juila prompt. To run an example case (e.g., default Maryland 2035 case in `PCM` mode), type `using HOPE`, and type `HOPE.run_hope("HOPE/ModelCases/MD_Excel_case/")`, you will see the **HOPE** is running: ![image](https://github.com/swang22/HOPE/assets/125523842/33fa4fbc-6109-45ce-ac41-f41a29885525) The results will be saved in `yourpath/home/HOPE/ModelCases/MD_Excel_case/output`. @@ -46,7 +46,7 @@ The results will be saved in `yourpath/home/HOPE/ModelCases/MD_Excel_case/output 1. Open **Command Prompt** from Windows **Start** and navigate to your home path:`/yourpath/home`. 2. Type `julia`. Julia will be opened as below: ![image](https://github.com/swang22/HOPE/assets/125523842/6c61bed1-bf8e-4186-bea2-22413fd1328e) -3. Type `]` into the Julia package mode, and type `activate HOPE` (if you are in your `home` directory), you will see prompt `(@v1.8)` changing to `(HOPE)`, which means the HOPE project is activated successfully. +3. Type `]` into the Julia package mode, and type `activate HOPE` (if you are in your `home` directory), you will see prompt `(@v1.8) pkg>` changing to `(HOPE) pkg>`, which means the HOPE project is activated successfully. 4. Type `instantiate` in the (HOPE) pkg prompt. ( After the HOPE is successfully installed, you can skip this step) 5. Type `st` to check that the dependencies (packages that HOPE needs) have been installed. Type `up` to update the version of dependencies (packages). (This step may take some time when you install HOPE for the first time. After the HOPE is successfully installed, you can skip this step) ![image](https://github.com/swang22/HOPE/assets/125523842/66ce1ea1-1b06-43d0-9f2b-542c473797aa) From e9cd2d96f50e99e5ff937c0d609b717154d160d4 Mon Sep 17 00:00:00 2001 From: Shen Wang <125523842+swang22@users.noreply.github.com> Date: Thu, 7 Dec 2023 00:17:26 -0500 Subject: [PATCH 3/9] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a65b449..e281fde 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,7 @@ The results will be saved in `yourpath/home/HOPE/ModelCases/MD_Excel_case/output The results will be saved in `yourpath/home/HOPE/ModelCases/MD_Excel_case/output`. ![image](https://github.com/swang22/HOPE/assets/125523842/7a760912-b8f2-4d5c-aea0-b85b6eb00bf4) 7. After finishing the setup and the first time successful run, you can skip steps 4 and 5 for your future runs. -![image](https://github.com/swang22/HOPE/assets/125523842/f2b491bb-d4ca-4dc4-8171-cba05cc10a23) + #### Mac users From 5636223059e47c488e15af5fe75e11725d5662d0 Mon Sep 17 00:00:00 2001 From: Shen Wang <125523842+swang22@users.noreply.github.com> Date: Thu, 7 Dec 2023 00:18:45 -0500 Subject: [PATCH 4/9] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e281fde..99a92b3 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,8 @@ Download [VScode](https://code.visualstudio.com/) and [install](https://code.vis To run an example case (e.g., default Maryland 2035 case in `PCM` mode), type `using HOPE`, and type `HOPE.run_hope("HOPE/ModelCases/MD_Excel_case/")`, you will see the **HOPE** is running: ![image](https://github.com/swang22/HOPE/assets/125523842/33fa4fbc-6109-45ce-ac41-f41a29885525) The results will be saved in `yourpath/home/HOPE/ModelCases/MD_Excel_case/output`. -![image](https://github.com/swang22/HOPE/assets/125523842/7a760912-b8f2-4d5c-aea0-b85b6eb00bf4) +![image](https://github.com/swang22/HOPE/assets/125523842/af68d3a7-4fe7-4d9c-97f5-6d8898e2c522) + 7. After finishing the setup and the first time successful run, you can skip steps 4 and 5 for your future runs. ### Using System Terminal to Run a Case From 42d9d3cbf494b5aad238440d5ad322ac1dee4a85 Mon Sep 17 00:00:00 2001 From: Shen Wang <125523842+swang22@users.noreply.github.com> Date: Thu, 7 Dec 2023 00:26:16 -0500 Subject: [PATCH 5/9] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 99a92b3..dd23a02 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ Download [VScode](https://code.visualstudio.com/) and [install](https://code.vis The results will be saved in `yourpath/home/HOPE/ModelCases/MD_Excel_case/output`. ![image](https://github.com/swang22/HOPE/assets/125523842/af68d3a7-4fe7-4d9c-97f5-6d8898e2c522) -7. After finishing the setup and the first time successful run, you can skip steps 4 and 5 for your future runs. +7. For your future new runs, you can skip steps 4 and 5, and just follow steps 1,2,3,6. ### Using System Terminal to Run a Case #### Windows users @@ -50,13 +50,13 @@ The results will be saved in `yourpath/home/HOPE/ModelCases/MD_Excel_case/output 3. Type `]` into the Julia package mode, and type `activate HOPE` (if you are in your `home` directory), you will see prompt `(@v1.8) pkg>` changing to `(HOPE) pkg>`, which means the HOPE project is activated successfully. 4. Type `instantiate` in the (HOPE) pkg prompt. ( After the HOPE is successfully installed, you can skip this step) 5. Type `st` to check that the dependencies (packages that HOPE needs) have been installed. Type `up` to update the version of dependencies (packages). (This step may take some time when you install HOPE for the first time. After the HOPE is successfully installed, you can skip this step) -![image](https://github.com/swang22/HOPE/assets/125523842/66ce1ea1-1b06-43d0-9f2b-542c473797aa) +![image](https://github.com/swan,g22/HOPE/assets/125523842/66ce1ea1-1b06-43d0-9f2b-542c473797aa) 6. If there is no error in the above processes, the **HOPE** model has been successfully installed. Then, click `Backspace` to return to the Juila prompt. To run an example case (e.g., default Maryland 2035 case in `PCM` mode), type `using HOPE`, and type `HOPE.run_hope("HOPE/ModelCases/MD_Excel_case/")`, you will see the **HOPE** is running: ![image](https://github.com/swang22/HOPE/assets/125523842/c36c6384-7e04-450d-921a-784c3b13f8bd) The results will be saved in `yourpath/home/HOPE/ModelCases/MD_Excel_case/output`. ![image](https://github.com/swang22/HOPE/assets/125523842/7a760912-b8f2-4d5c-aea0-b85b6eb00bf4) -7. After finishing the setup and the first time successful run, you can skip steps 4 and 5 for your future runs. +7. For your future new runs, you can skip steps 4 and 5, and just follow steps 1,2,3,6. #### Mac users From 9efee545090eb3be5e8424ab4b5fe67458d1d02e Mon Sep 17 00:00:00 2001 From: Shen Wang <125523842+swang22@users.noreply.github.com> Date: Thu, 7 Dec 2023 19:07:44 -0500 Subject: [PATCH 6/9] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index dd23a02..c2ccc14 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,8 @@ The HOPE model was originally developed by a team of researchers in Prof. [Benja ### Install Julia and clone the HOPE repository 1. Install [Julia](http://julialang.org/) language. 2. Clone or download the **HOPE** repository to your local directory. For example, save the **HOPE** project in your `home` directory:`/yourpath/home/HOPE`. +![image](https://github.com/swang22/HOPE/assets/125523842/2f4bd9bd-0a0c-46e3-9146-e5aeaa558f92) + ### Using Visual Studio Code to Run a Case (Recommended) Download [VScode](https://code.visualstudio.com/) and [install](https://code.visualstudio.com/docs/setup/setup-overview) it. 1. Open the VScode, click the 'File' tab, select 'Open Folder...', and navigate to your home path:`/yourpath/home`. From 2e5de900acb65ab27128757399602d1409cad1d2 Mon Sep 17 00:00:00 2001 From: Shen Wang <125523842+swang22@users.noreply.github.com> Date: Thu, 7 Dec 2023 19:10:07 -0500 Subject: [PATCH 7/9] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c2ccc14..fa9048c 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,8 @@ The HOPE model was originally developed by a team of researchers in Prof. [Benja ### Install Julia and clone the HOPE repository 1. Install [Julia](http://julialang.org/) language. 2. Clone or download the **HOPE** repository to your local directory. For example, save the **HOPE** project in your `home` directory:`/yourpath/home/HOPE`. -![image](https://github.com/swang22/HOPE/assets/125523842/2f4bd9bd-0a0c-46e3-9146-e5aeaa558f92) +![image](https://github.com/swang22/HOPE/assets/125523842/6cd0feae-dec8-439f-a44d-98896228029e) + ### Using Visual Studio Code to Run a Case (Recommended) Download [VScode](https://code.visualstudio.com/) and [install](https://code.visualstudio.com/docs/setup/setup-overview) it. From 38f2af60c9e6d0e19fb9c83e44350b33262f711f Mon Sep 17 00:00:00 2001 From: zoe667 <144710777+zoe667@users.noreply.github.com> Date: Thu, 7 Dec 2023 20:06:01 -0500 Subject: [PATCH 8/9] Update README.md changed README modules, titles, and some descriptions to make it clearer. --- README.md | 73 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 47 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index fa9048c..6ac6d84 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ This project is funded by [Maryland Energy Administration](https://energy.maryland.gov/Pages/default.aspx) -## Overview +# 1. Overview The **Holistic Optimization Program for Electricity (HOPE)** model is a transparent and open-source tool for evaluating electric sector transition pathways and policy scenarios regarding power system planning, system operation, optimal power flow, and market designs. It is a highly configurable and modulized tool coded in the [Julia](http://julialang.org/) language and optimization package [JuMP](http://jump.dev/). The HOPE consists of multiple modes for modeling optimization problems of modern power systems and electricity markets, including: 1. `GTEP` mode: a generation & transmission expansion planning model 2. `PCM` mode: a production cost model @@ -20,49 +20,70 @@ Users can select the proper mode of HOPE based on their research needs. Each mod The HOPE model was originally developed by a team of researchers in Prof. [Benjamin F. Hobbs's group](https://hobbsgroup.johnshopkins.edu/) at [Johns Hopkins University](https://www.jhu.edu/). The main contributors include Dr. [Shen Wang](https://ceepr.mit.edu/people/wang/) and Dr. [Mahdi Mehrtash](https://www.mahdimehrtash.com/). -## Installation -### Install Julia and clone the HOPE repository -1. Install [Julia](http://julialang.org/) language. -2. Clone or download the **HOPE** repository to your local directory. For example, save the **HOPE** project in your `home` directory:`/yourpath/home/HOPE`. -![image](https://github.com/swang22/HOPE/assets/125523842/6cd0feae-dec8-439f-a44d-98896228029e) +# 2. Preparation Phase +## 2.1 Install Julia +Install [Julia](http://julialang.org/) language. +## 2.2 Download HOPE repository +Clone OR download the **HOPE** repository to your local directory - click green "Code" button and choose "Download ZIP". This step will allow you to save the **HOPE** project in your `home` directory:`/yourpath/home/HOPE`. +![image](https://github.com/swang22/HOPE/assets/125523842/6cd0feae-dec8-439f-a44d-98896228029e) +If you are in README.md file, go back to HOPE repository, then follow the above steps. -### Using Visual Studio Code to Run a Case (Recommended) +## 2.3 Install Visual Studio Code (Recommended) Download [VScode](https://code.visualstudio.com/) and [install](https://code.visualstudio.com/docs/setup/setup-overview) it. -1. Open the VScode, click the 'File' tab, select 'Open Folder...', and navigate to your home path:`/yourpath/home`. -2. In the VScode TERMINAL, type `Julia`. Julia will be opened as below: + +# 3. Run a Case in HOPE +## 3.1 Using VScode to Run a Case +**(1)** Open the VScode, click the 'File' tab, select 'Open Folder...', and navigate to your home path:`/yourpath/home`. + +**(2)** In the VScode TERMINAL, type `Julia` and press "Enter" button (If this does not work, press "CTRL + Shift + P", choose "Julia Environment"). Julia will be opened as below: ![image](https://github.com/swang22/HOPE/assets/125523842/5fc3a8c9-23f8-44a3-92ab-135c4dbdc118) -3. Type `]` into the Julia package mode, and type `activate HOPE` (if you are in your `home` directory) or `activate yourpath/home/HOPE` (if you are not in your `home` directory), you will see prompt `(@v1.8) pkg>` changing to `(HOPE) pkg>`, which means the HOPE project is activated successfully. + +**(3)** Type `]` into the Julia package mode, and type `activate HOPE` (if you are in your `home` directory) or `activate yourpath/home/HOPE` (if you are not in your `home` directory), you will see prompt `(@v1.8) pkg>` changing to `(HOPE) pkg>`, which means the HOPE project is activated successfully. ![image](https://github.com/swang22/HOPE/assets/125523842/2a0c259d-060e-4799-a044-8dedb8e5cc4d) -4. Type `instantiate` in the (HOPE) pkg prompt (make sure you are in your `home` directory, not the `home/HOPE` directory!). -5. Type `st` to check that the dependencies (packages that HOPE needs) have been installed. Type `up` to update the version of dependencies (packages). (This step may take some time when you install HOPE for the first time. After the HOPE is successfully installed, you can skip this step) + +**(4)** Type `instantiate` in the (HOPE) pkg prompt (make sure you are in your `home` directory, not the `home/HOPE` directory!). + +**(5)** Type `st` to check that the dependencies (packages that HOPE needs) have been installed. Type `up` to update the version of dependencies (packages). (This step may take some time when you install HOPE for the first time. After the HOPE is successfully installed, you can skip this step) + ![image](https://github.com/swang22/HOPE/assets/125523842/1eddf81c-97e4-4334-85ee-44958fcf8c2f) -6. If there is no error in the above processes, the **HOPE** model has been successfully installed. Then, click `Backspace` to return to the Juila prompt. - To run an example case (e.g., default Maryland 2035 case in `PCM` mode), type `using HOPE`, and type `HOPE.run_hope("HOPE/ModelCases/MD_Excel_case/")`, you will see the **HOPE** is running: + +**(6)** If there is no error in the above processes, the **HOPE** model has been successfully installed. Then, click `Backspace` to return to the Juila prompt. To run an example case (e.g., default Maryland 2035 case in `PCM` mode), type `using HOPE`, and type `HOPE.run_hope("HOPE/ModelCases/MD_Excel_case/")`, you will see the **HOPE** is running: ![image](https://github.com/swang22/HOPE/assets/125523842/33fa4fbc-6109-45ce-ac41-f41a29885525) The results will be saved in `yourpath/home/HOPE/ModelCases/MD_Excel_case/output`. ![image](https://github.com/swang22/HOPE/assets/125523842/af68d3a7-4fe7-4d9c-97f5-6d8898e2c522) -7. For your future new runs, you can skip steps 4 and 5, and just follow steps 1,2,3,6. +**(7)** For your future new runs, you can skip steps 4 and 5, and just follow steps 1,2,3,6. + +## 3.2 Using System Terminal to Run a Case +You can use system terminal () either with a "Windows system" or a "Mac system" to run a test case. See details below. +### 3.2.1 Windows users +**(1)** Open **Command Prompt** from Windows **Start** and navigate to your home path:`/yourpath/home`. + +**(2)** Type `julia`. Julia will be opened as below: -### Using System Terminal to Run a Case -#### Windows users -1. Open **Command Prompt** from Windows **Start** and navigate to your home path:`/yourpath/home`. -2. Type `julia`. Julia will be opened as below: ![image](https://github.com/swang22/HOPE/assets/125523842/6c61bed1-bf8e-4186-bea2-22413fd1328e) -3. Type `]` into the Julia package mode, and type `activate HOPE` (if you are in your `home` directory), you will see prompt `(@v1.8) pkg>` changing to `(HOPE) pkg>`, which means the HOPE project is activated successfully. -4. Type `instantiate` in the (HOPE) pkg prompt. ( After the HOPE is successfully installed, you can skip this step) -5. Type `st` to check that the dependencies (packages that HOPE needs) have been installed. Type `up` to update the version of dependencies (packages). (This step may take some time when you install HOPE for the first time. After the HOPE is successfully installed, you can skip this step) + +**(3)** Type `]` into the Julia package mode, and type `activate HOPE` (if you are in your `home` directory), you will see prompt `(@v1.8) pkg>` changing to `(HOPE) pkg>`, which means the HOPE project is activated successfully. + +**(4)** Type `instantiate` in the (HOPE) pkg prompt. ( After the HOPE is successfully installed, you can skip this step) + +**(5)** Type `st` to check that the dependencies (packages that HOPE needs) have been installed. Type `up` to update the version of dependencies (packages). (This step may take some time when you install HOPE for the first time. After the HOPE is successfully installed, you can skip this step) + ![image](https://github.com/swan,g22/HOPE/assets/125523842/66ce1ea1-1b06-43d0-9f2b-542c473797aa) -6. If there is no error in the above processes, the **HOPE** model has been successfully installed. Then, click `Backspace` to return to the Juila prompt. - To run an example case (e.g., default Maryland 2035 case in `PCM` mode), type `using HOPE`, and type `HOPE.run_hope("HOPE/ModelCases/MD_Excel_case/")`, you will see the **HOPE** is running: + +**(6)** If there is no error in the above processes, the **HOPE** model has been successfully installed. Then, click `Backspace` to return to the Juila prompt. To run an example case (e.g., default Maryland 2035 case in `PCM` mode), type `using HOPE`, and type `HOPE.run_hope("HOPE/ModelCases/MD_Excel_case/")`, you will see the **HOPE** is running: + ![image](https://github.com/swang22/HOPE/assets/125523842/c36c6384-7e04-450d-921a-784c3b13f8bd) + The results will be saved in `yourpath/home/HOPE/ModelCases/MD_Excel_case/output`. + ![image](https://github.com/swang22/HOPE/assets/125523842/7a760912-b8f2-4d5c-aea0-b85b6eb00bf4) -7. For your future new runs, you can skip steps 4 and 5, and just follow steps 1,2,3,6. + +**(7)** For your future new runs, you can skip steps 4 and 5, and just follow steps 1,2,3,6. -#### Mac users +#### 3.2.2 Mac users ## Solvers ### Free Solvers From 0a95ed96a7197c29f1f1fd9e9f9f4535bd1a4299 Mon Sep 17 00:00:00 2001 From: zoe667 <144710777+zoe667@users.noreply.github.com> Date: Thu, 7 Dec 2023 20:18:27 -0500 Subject: [PATCH 9/9] Update README.md --- README.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 6ac6d84..557eab6 100644 --- a/README.md +++ b/README.md @@ -28,18 +28,19 @@ Install [Julia](http://julialang.org/) language. Clone OR download the **HOPE** repository to your local directory - click green "Code" button and choose "Download ZIP". This step will allow you to save the **HOPE** project in your `home` directory:`/yourpath/home/HOPE`. ![image](https://github.com/swang22/HOPE/assets/125523842/6cd0feae-dec8-439f-a44d-98896228029e) If you are in README.md file, go back to HOPE repository, then follow the above steps. - -## 2.3 Install Visual Studio Code (Recommended) -Download [VScode](https://code.visualstudio.com/) and [install](https://code.visualstudio.com/docs/setup/setup-overview) it. + # 3. Run a Case in HOPE -## 3.1 Using VScode to Run a Case +## 3.1 Using VScode to Run a Case (Recommend) +Install Visual Studio Code: Download [VScode](https://code.visualstudio.com/) and [install](https://code.visualstudio.com/docs/setup/setup-overview) it. **(1)** Open the VScode, click the 'File' tab, select 'Open Folder...', and navigate to your home path:`/yourpath/home`. **(2)** In the VScode TERMINAL, type `Julia` and press "Enter" button (If this does not work, press "CTRL + Shift + P", choose "Julia Environment"). Julia will be opened as below: + ![image](https://github.com/swang22/HOPE/assets/125523842/5fc3a8c9-23f8-44a3-92ab-135c4dbdc118) **(3)** Type `]` into the Julia package mode, and type `activate HOPE` (if you are in your `home` directory) or `activate yourpath/home/HOPE` (if you are not in your `home` directory), you will see prompt `(@v1.8) pkg>` changing to `(HOPE) pkg>`, which means the HOPE project is activated successfully. + ![image](https://github.com/swang22/HOPE/assets/125523842/2a0c259d-060e-4799-a044-8dedb8e5cc4d) **(4)** Type `instantiate` in the (HOPE) pkg prompt (make sure you are in your `home` directory, not the `home/HOPE` directory!). @@ -48,7 +49,7 @@ Download [VScode](https://code.visualstudio.com/) and [install](https://code.vis ![image](https://github.com/swang22/HOPE/assets/125523842/1eddf81c-97e4-4334-85ee-44958fcf8c2f) -**(6)** If there is no error in the above processes, the **HOPE** model has been successfully installed. Then, click `Backspace` to return to the Juila prompt. To run an example case (e.g., default Maryland 2035 case in `PCM` mode), type `using HOPE`, and type `HOPE.run_hope("HOPE/ModelCases/MD_Excel_case/")`, you will see the **HOPE** is running: +**(6)** If there is no error in the above processes, the **HOPE** model has been successfully installed! Then, press `Backspace` button to return to the Juila prompt. To run an example case (e.g., default Maryland 2035 case in `PCM` mode), type `using HOPE`, and type `HOPE.run_hope("HOPE/ModelCases/MD_Excel_case/")`, you will see the **HOPE** is running: ![image](https://github.com/swang22/HOPE/assets/125523842/33fa4fbc-6109-45ce-ac41-f41a29885525) The results will be saved in `yourpath/home/HOPE/ModelCases/MD_Excel_case/output`. ![image](https://github.com/swang22/HOPE/assets/125523842/af68d3a7-4fe7-4d9c-97f5-6d8898e2c522) @@ -85,14 +86,16 @@ The results will be saved in `yourpath/home/HOPE/ModelCases/MD_Excel_case/output #### 3.2.2 Mac users -## Solvers -### Free Solvers - +# 4. Solvers +## 4.1 Free Solvers +CBC -### Commercial Solvers +## 4.2 Commercial Solvers +Gorubi +# 5. Documentation -## Program Sponsors +# 6. Program Sponsors