Skip to content

Quickstart

1. Start the Application

Section titled “1. Start the Application”
Terminal window
python app/main.py

The NiceGUI dashboard opens automatically in your browser (or navigate to http://localhost:8080).

2. Connect a Data Source

Section titled “2. Connect a Data Source”

On first launch, configure your data source in the Settings tab:

  • Enter your database credentials (PostgreSQL)
  • Enter your WebSocket endpoint URI
  • Click Save & Connect

Database settings

3. Select an Experiment

Section titled “3. Select an Experiment”

Switch to the Experimental Insight tab:

  1. Select one or more experiments from the available experiment table
  2. Click Visualize Selected Experiments to get experimental insights

Experiment selection

  1. Use the interactive plots to get insights into your experiments

Experimental graphs

4. Explore the Dashboard

Section titled “4. Explore the Dashboard”
PageWhat it shows
Experimental InsightInteractive time-series plots for all parameters of the experiment of interest
Model ControlSelection of training data and used models, configure and run models, simulate experiments, and evaluate predictions
Performance MetricsVisualization of training/prediction metrics for selected experiment
Database SettingsConfiguration of database connection and database adjustments

5. Run a Prediction

Section titled “5. Run a Prediction”
  1. Go to the Run models panel in the model control page
  2. Select an individual model (LSTM, XGBoost, Linear Regression) or run all at once
  3. Click Run — the forecast overlays on the experiment chart in the Experimental Insight page

Run models

Next Steps

Section titled “Next Steps”