pareto-ui

User Interface for the PARETO project

Getting started (developer)

Prerequisites

The following steps assume that:

1. conda is already installed and configured
2. This repository (i.e. the Pareto UI repository, https://github.com/project-pareto/pareto-ui) has been cloned locally and the working directory is set to the root of the repository

1. Creating the Conda environment

Run the following command to create and activate a new Conda environment named pareto-ui-env:

conda env create --file environment.yml && conda activate pareto-ui-env

This will install the correct runtime versions of both the backend (Python) and frontend (JavaScript/NodeJS/Electron) portions of the UI, as well as the backend (Python) dependencies.

2. Install the IDAES solver dependencies

idaes get-extensions --verbose

3. Install Javascript dependencies

Prerequisites: Node Package Manager (npm)

cd <pareto-ui-path>/electron
npm clean-install

Running the UI

Ensure that the pareto-ui-env Conda environment is active

conda activate pareto-ui-env

Option 1: Run UI in browser

cd <pareto-ui-path>/electron
npm run app-start

Option 2: Run UI with electron

cd <pareto-ui-path>/electron
npm run electron-start

Build Electron App (Experimental)

MacOS

cd <pareto-ui-path>/electron
npm run dist:mac