FUSION GUI Overview

This directory contains the design documentation for the FUSION web-based graphical user interface.

What is FUSION GUI?

FUSION GUI is a browser-based interface for the FUSION optical network simulator. It allows users to:

  • Configure and launch simulations without using the CLI

  • Monitor running simulations with real-time progress and logs

  • Browse and download output artifacts

  • Visualize network topology and results

  • Edit configuration files with validation

Design Philosophy

  1. Local-first: Runs on localhost, single-user, no authentication required

  2. Zero friction for users: pip install fusion[gui] then fusion gui - no Node.js needed

  3. Developer friendly: Hot reload for both frontend and backend during development

  4. Subprocess isolation: Simulations run as separate processes for stability and clean cancellation

  5. Stateless where possible: Server can restart without losing track of running jobs

Documentation Index

Document

Description

01-architecture.md

System architecture and component overview

02-run-lifecycle.md

Simulation run states and transitions

03-run-directory-contract.md

File/directory structure for each run

04-api.md

REST API specification

05-frontend-standards.md

React/TypeScript conventions and patterns

06-backend-standards.md

Python/FastAPI conventions and patterns

07-contributing.md

Contribution guidelines and PR checklist

08-ci-cd.md

CI/CD pipeline and release process

09-roadmap.md

Phased implementation plan with milestones

10-testing.md

Testing strategy and requirements

Diagrams

Architecture Decision Records