Run a Case in HOPE

Using VScode to Run a Case (Recommended)

Install Visual Studio Code: Download VScode and install it. A short video tutorial on how to install VScode and add Julia to it can be found here.

(1) Open the VScode, click the 'File' tab, select 'Open Folder...', and navigate to your home working directory:/yourpath/home (The home directory in the examples below is named Maryland-Electric-Sector-Transition).

(2) In the VScode TERMINAL, type Julia and press the "Enter" button. Julia will be opened as below:

(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.

(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)

(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:

The results will be saved in yourpath/home/HOPE/ModelCases/MD_Excel_case/output.

(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

You can use a system terminal either with a "Windows system" or a "Mac system" to run a test case. See details below.

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:

(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)

(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:

The results will be saved in yourpath/home/HOPE/ModelCases/MD_Excel_case/output.

(7) For your future new runs, you can skip steps 4 and 5, and just follow steps 1, 2, 3, 6.