maopl/transopt

TranOpt:

Overview

TransOpt is a sophisticated web-based platform designed to facilitate optimization experiments ...

Features

...

Installation

TransOpt is composed of two main components: the backend for data processing and business logic, and the frontend for user interaction. Each can be installed as follows:

Prerequisites

Before installing TransOpt, you must have the following installed:

• Python 3.8+: Ensure Python is installed.
• Node.js and npm: These are required to install and build the frontend. Download Node.js

Please install these prerequisites if they are not already installed on your system.

Backend Installation

Install from source:

$ git clone --recurse-submodules https://github.com/maopl/TransOpt.git 
$ cd TransOpt
$ pip install -r requirements.txt
$ python setup.py install
$ bash scripts/init_docker.sh
$ bash scripts/init_csstuning.sh

Frontend Installation

Navigate to the webui directory and install the necessary packages:

$ cd webui && npm install

Getting Started

After installation, you can start the backend and frontend as follows:

1. Start the backend server:

   $ transopt-server

2. In a new terminal, launch the frontend:

   $ cd webui && npm start

This will open the TransOpt interface in your default web browser at http://localhost:3000.

Documentation

For more detailed information on configuring and using TransOpt, refer to our full documentation here.

Support

For issues, feature requests, or contributions, please visit our GitHub Issues page.

Citation

If you find our work helpful to your research, please consider citing our:

@software{TransOpt,
  title = {{TransOpt}: Multi-Objective Optimization Experiment Platform},
  author = {Author Name and Collaborator Name},
  url = {https://github.com/maopl/TransOpt},
  year = {2024}
}