Hero image

Componentized-WEAP/LEAP RESTful Frameworks

Componentized-WEAP (C-WEAP) and Componentized-LEAP (C-LEAP) are a RESTful frameworks written in NodeJS.

The Componentized-WEAP (C-WEAP) and Componentized-LEAP (C-WEAP) are RESTful frameworks written in NodeJS for the Water Evaluation and Planning (WEAP) and the Low Emissions Analysis Platform (LEAP) Systems. 

The nexus between the water (C-WEAP) and energy (C-LEAP) models can be modeled and simulated with the WEAP-KIB-LEAP framework. More information is available here.

Installation

Computing platforms: Windows 10 OS (see WEAP) and LEAP).

Installation Steps

  1. Download & Install NodeJS (use MSI with default choices)
  2. Download & Install Python 2.7 (use MSI with default settings), and add python path to the “Environment Variables” of the Windows OS (add to system variables)
  3. Open command line (cmd) in windows and run:

    npm install npm –global
    npm install typescript –global
    npm install node-gyp –global
  4. Open Windows PowerShell (run as administrator) and run the following command.
    This step may take time and further require multiple runs.

    npm install –global –production windows-build-tools
  5. Download & Install Visual C++ from here if there is any error in executing step 4.

IDE Installation

Any IDE can be used for programming, but we recommend VS-Code. In the following, the required extensions and configurations are mentioned to run the C-WEAP and C-LEAP frameworks.

  1. Download & Install VS-Code (choose user installer)
  2. Download & Install Git
  3. Install TSLint extension in VS-Code (open VS-Code, go to the extension page, type TSLint, and click on install button)

Execution Policy

Note: The execution policy in the Windows Client must be change to RemoteSigned to be able to run scripts. For more information see About Execution Policy and Set Execution Policy. So, open Windows PowerShell (run as administrator), and run:

  • Set-ExecutionPolicy RemoteSigned

Running Componentized-WEAP and Componentized-LEAP in VS-Code

To run the C-WEAP framework in the VS-Code, follow these steps:

  1. Open VS-Code
  2. Press CTRL+SHIFT+P (View/Command Palette…) and type “git:clone
  3. Enter the C-WEAP (C-LEAP) git URL (https://github.com/comses/ComponentizedWEAP.git) or C-LEAP git URL (https://github.com/comses/ComponentizedLEAP)
  4. Select the folder for the project to be uploaded
  5. Open VS-Code terminal (right click on the project and select Open in Terminal) and run the following command to update the required packages.

    npm install
  6. Press CTRL+SHIFT+P and type tasks:run build task (to rebuild the JavaScript code)
  7. Run the project (using launch.json)

WEAP and LEAP Software Systems

These are proprietary software. For more information on licensing visit https://www.weap21.org/index.asp?action=217 and https://leap.sei.org/default.asp?action=license.

Copyright: The C-WEAP and C-LEAP software are developed at ACIMS/ASU with GNU Lesser General Public License version 3.0 (LGPLv3).

References

  • M.D. Fard and H.S. Sarjoughian, 2021, “A RESTful Framework Design for Componentizing the Water Evaluation and Planning WEAP System”, Simulation Modelling Practice and Theory, 106, 1-19, https://doi.org/10.1016/j.simpat.2020.102199.
  • M.D. Fard, H.S. Sarjoughian, I. Mahmood, A. Mounir, X. Guan, and G. Mascaro, 2020, “Modeling the Water-Energy Nexus for the Phoenix Active Management Area”, Winter Simulation Conference, Virtual Conference, December 14-18, USA.
  • M.D. Fard and H.S. Sarjoughian, 2020, “Coupling WEAP And LEAP Models Using Interaction Modeling”, 52nd Annual Simulation Symposium, SpringSim conference, May, Fairfax, VA, USA.
  • M.D. Fard and H.S. Sarjoughian, 2019, “A Web-service Framework for the Water Evaluation and Planning System”, 15th Symposium on Theory and Foundations for Modeling & Simulation, April, SpringSim conference, Tucson, AZ, USA.

Contact

Point of contact: Hessam S. Sarjoughian (hss@asu.edu)

C-WEAP Simulator

Version: 1.0, released May 28, 2020

C-LEAP Simulator

Version: 1.0, released February 2, 2021