The Evolver Dashboard is a web-based application built with Streamlit that allows to configure and execute Evolver from an user-friendly web application.
- Python 3.9 and <3.11
- This project requires Evolver's jar to be built. Read the main README for more information.
There are several ways to install the dashboard, it is recommended to use a virtual environment to avoid conflicts with other packages. You can learn more about them here.
- Cloning and installing the package:
$ git clone https://github.com/jMetal/Evolver.git
# or
$ git clone [email protected]:jMetal/Evolver.git
# go to the evolver-dashboard folder
$ cd evolver-dashboard
# and install the package
$ pip install .
# or for development
$ pip install -e .
- Installing the latest version of the package directly from github with https or git:
$ pip install "evolver @ git+ssh://[email protected]/jMetal/Evolver.git#subdirectory=evolver-dashboard"
# or
$ pip install "evolver @ git+https://github.com/jMetal/Evolver.git#subdirectory=evolver-dashboard"
The easiest way to execute the dashboard is by running the evolver module:
$ python -m evolver
Additionally, you can check the available options by executing:
$ python -m evolver --help
Container image: ghcr.io/jmetal/evolver-dashboard
Tags: latest
Usage:
For basic usage, you don't need to mount any volume, to save the results use the download option in the dashboard
$ docker run --rm -p 8501:8501 \
ghcr.io/jmetal/evolver-dashboard:latest
For more advanced usage, you can mount a volume to save the results in your local machine as well as launch it as a permanent container that you can connect to later
$ docker run -v <local/output/folder>:/tmp/evolver \
-p 8501:8501 ghcr.io/jmetal/evolver-dashboard:latest