Algomancy 0.3.18

A dashboarding framework for visualizing performances of algorithms or simulations in various scenarios.

Algomancy

Algomancy is a lightweight framework for building interactive dashboards that visualize the performance of algorithms and/or simulations across scenarios. It brings together ETL, scenario orchestration, KPI computation, and a Dash-based UI with modular pages.

Highlights

• Python 3.14+
• Dash UI with modular pages and a production-ready server
• Batteries-included packages: content, data, scenario, GUI, CLI

Installation

• Using uv (recommended):

  uv add algomancy
  

• Using pip:

  pip install algomancy
  

Minimal example

The following example launches a small placeholder dashboard using the default building blocks from the Algomancy ecosystem. Copy this into a file called main.py and run it.

Set up folder structure

1. Create the following directory structure:

root/
|── assets/ (*)
├── data/   (*)
├── src/
│   ├── data_handling/
│   ├── pages/
│   └── templates/
│       ├── kpi/
│       └── algorithm/
├── main.py  (*)
├── README.md
└── pyproject.toml

Only the items marked (*) are required.

2. create main.py

from algomancy_gui.gui_launcher import GuiLauncher
from algomancy_gui.appconfiguration import AppConfiguration
from algomancy_content import (
    PlaceholderETLFactory,
    PlaceholderAlgorithm,
    PlaceholderKPI,
    placeholder_input_config,
)
from algomancy_data import DataSource


def main() -> None:
    host = "127.0.0.1"
    port = 8050

    app_cfg = AppConfiguration(
        etl_factory     = PlaceholderETLFactory,
        kpi_templates   = {"placeholder": PlaceholderKPI},
        algo_templates  = {"placeholder": PlaceholderAlgorithm},
        input_configs   = [placeholder_input_config],
        host            = host,
        port            = port,
        title           = "My Algomancy Dashboard",
    )

    app = GuiLauncher.build(app_cfg)
    GuiLauncher.run(app=app, host=app_cfg.host, port=app_cfg.port)


if __name__ == "__main__":
    main()

Run

• Save the file as main.py and start the app:

  uv run main.py
  

• Open your browser at http://127.0.0.1:8050

Examples

• A more complete example (including assets and templates) is available in the algomancy repository under example/. The entry point is example/main.py.

Requirements

• Python 3.14+
• Windows, macOS, or Linux

CLI

• This package also exposes a CLI entry point algomancy-cli. Run algomancy-cli --help for usage.

License

• See the LICENSE file included with this distribution.

Changelog

• See changelog.md for notable changes.