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

Install On Windows

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

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

** If you run into npm ERR!, try running npm clean-install -d

Install On MacOS ARM64

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-mac.yml && conda activate pareto-ui-env

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

2. Uninstall x86-64 versions of numpy and pandas

pip uninstall -y numpy pandas

3. Install osx/arm64 versions of numpy and pandas

conda install -y -c conda-forge/osx-arm64 numpy pandas=2.0.3

4. Install the IDAES solver dependencies

idaes get-extensions --verbose

5. Install Javascript dependencies

Prerequisites: Node Package Manager (npm)

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

cd <pareto-ui-path>/electron/ui
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/ui
npm run app-start

Option 2: Run UI with electron

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

Building production Electron App

Windows (requires Windows OS):

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

Mac (requires Mac OS):

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