Skip to content

Latest commit

 

History

History
182 lines (109 loc) · 6.74 KB

README.md

File metadata and controls

182 lines (109 loc) · 6.74 KB
Raw

Visualising Optimisation Data

This is the COMP3000 Computing Project on the topic of creating "A Web Platform for Visualising Optimisation Data".

Project Supervisor: Dr. David Walker

Poster

Project poster

Project Vision

This project aims to develop a “Web Platform for Visualising Optimisation Data”, for evolutionary computation research at the University of Plymouth, to visualise aspects of optimisation data that is generated from evolutionary algorithms.

The web platform will provide:

  • the ability for the optimisation data collected from client optimisers to be visualised in real-time,
  • the playback of saved optimisation runs,
  • a deployed web platform acting as a single tool which collects all appropriate visualisations for optimisation runs.

A demonstration of the project is available on YouTube.

Installation

The following pieces of software need to be installed on your machine in order to set up the local development environment:

Once the required software has been installed, you can proceed with setting up the codebase and installing packages/dependencies:

  1. Clone the repository from GitHub using the following command:
git clone https://github.com/GoelBiju/Visualising-Optimisation-Data.git
  1. Install the packages required for the frontend and plugins:
yarn install
  1. Install the packages required for the backend by changing the directory into the backend and using the following command:
cd backend && yarn install

Running frontend, backend and plugins

Once all the packages/dependencies have been installed for both the frontend and backend, the stack can be run in the following order:

  1. Start the backend from the root of the project:
yarn backend
  1. Run the frontend from the root using:
yarn frontend
  1. At present there are two plugin examples:

For the Pareto Front plugin, run:

yarn pareto

for the Line Graph plugin, run:

yarn line

In order to feed in data to the database and see real-time visualisation, see the section below to run optimser clients.

Running client scripts

The current examples provided make use of Python 3.8.10.

(Optional) Set up a virtual environment:

python -m venv --system-site-packages .\venv
.\venv\Scripts\activate

To run and test the sample data already provided, install the Python dependencies from the root of the project:

pip install --user -r requirements.txt

The optimiser client scripts are in the "/scripts" folder, you can run from them the root of the project with the following:

Run DTLZ1:

python scripts/dtlz1.py

Run DTLZ2:

python scripts/dtlz2.py

The frontend will show all active optmiser client runs once the script has been started and any completed runs stored in the database.

Development

Creating Plugins

To create a plugin you can copy any of the existing plugins in the packages folder.

To configure the plugin to work with the frontend, you will need to set its name and description through the files in the plugin folder:

  1. webpackConfig.output.library in craco.config.js to the plugin name,

  2. settings.json/deploy-settings.json to add the plugin details (look at examples already provided),

  3. name in package.json of the plugin project,

  4. div id in index.html in public folder of plugin project to identify where the plugin will load,

  5. registerRouteAction in src/App.tsx for the plugin and provide additional plugin details,

  6. pluginName in src/index.tsx,

  7. plugins command in package.json to add the plugin to start with the command,

  8. web dyno start in Procfile for plugin project (if you are using Heroku).

Deploying backend to Heroku

You will need to create a backend application on Heroku and add the GitHub repository to it.

The backend requires you to make use of an external MongoDB service. For this reason you will need to specify a "MONGODB_URI" configuration key in the config vars in Heroku settings for the backend application. You could use MongoDB Atlas and get a URI to access a database on a cluster.

The backend application does not require any further configuration and uses the default "heroku/nodejs" buildpack which will automatically be recognised when the application is first deployed which triggers npm start on its web dyno.

Deploying frontend and plugins to Heroku

The Heroku deployment is not necessary if the project is to be hosted elsewhere, but, if you want to host on Heroku then you will need to make use of the Heroku multi-procfile buildpack.

  1. Create your apps for the frontend and plugins,

  2. Ensure you connect the GitHub repository to the frontend and plugin apps,

  3. For each of the apps you will need to add the multi-procfile buildpack and the node.js buildpack if it is already not present,

  4. In the frontend application add a "PROCFILE" configuration key with the value indicating the location of the frontend Procfile with respect to the repository root (e.g. packages/frontend/Procfile),

  5. In the frontend application add a "REACT_APP_SETTINGS" key with the value of the name of the settings.json which will be used in the deployed environment (i.e. Heroku) e.g. this can be set to the default "deploy-settings.json",

  6. For each plugin application add a "PROCFILE" configuration key and set the value to the location of the Procfile for the plugin (with respect to the project root) e.g. packages/pareto-front/Procfile or packages/line/Procfile

After this has been set up the application should be deployed from the main branch of the repository.

Deployments

All of the components of the system have already been deployed as a demonstration of the service. The following table shows the deployed applications and their respective locations:

Application Deployed Location
Frontend http://opt-vis-frontend.herokuapp.com/
Backend http://opt-vis-backend.herokuapp.com/
Pareto-front (plugin) https://opt-vis-pareto-front.herokuapp.com/
Line Graph (plugin) https://opt-vis-line.herokuapp.com/