DEVS Generation Gallery

This repository is the distribution hub for simulators generated by DEVS-Gen.

Each simulator is a first-class gallery item. A simulator item always contains a runnable simulator package and may also include an optional Godot visualization that subscribes to the simulator's event trace.

What this repository contains

This repository is a standalone catalog of generated DEVS simulators and optional Godot visualizations.

• Use it to browse and download runnable simulator packages.
• Use it to explore optional Godot scenes that animate simulator event traces.
• Use it as a reference layout for packaging future simulator and visualization pairs.

If you want the upstream generator that produced these simulator packages, see our project page DEVS-Gen.

Repository layout

devs_gen_gallery/
  simulators/
    <name>/
      README.md         # Human-facing landing page for the simulator item
      simulator/        # Self-contained generated simulator package
      godot/            # Optional Godot visualization project
  doc/                  # Visualization-generation and setup guides

The original generated package metadata is preserved inside each simulator/README.md. The README.md files one level above are the gallery-facing entry points for users browsing this repository.

Quick start

1. Choose an item under simulators/.
2. Enter its simulator/ directory.
3. Install the runtime dependency used by the generated package, typically xDEVS.py.
4. Run python run.py with the scenario arguments described in the package README.

Example:

cd simulators/ABP/simulator
python run.py --total_packets 8 --simulate_time 1000

If a simulator item also contains a godot/ directory, that item includes a visualization project in addition to the simulator package.

Catalog

See simulators/README.md for the simulator catalog.

Current items:

• ABP - Alternating Bit Protocol
• IOBS - Island Observing Station
• OTrain - Ottawa O-Train light rail system
• SA - Strategic Airlift logistics, with a Godot visualization
• SEIRD - Epidemiological dynamics model
• barbershop - Barber shop queueing system
• oft - Offline file transfer workflow

Building Godot visualizations

This repository already includes the guidance for generating Godot visualizations that subscribe to simulator event traces.

• doc/Agent_Godogen_Setup_Guide.md explains the end-to-end workflow.
• doc/godogen_dev_prompt.md is the prompt specification used to generate the Godot project.

At a high level:

1. Generate a simulator package with DEVS-Gen.
2. Use the simulator package as the input workspace context for godogen or other similar game development skills.
3. Generate a sibling Godot project that subscribes to the simulator's MQTT event stream.
4. Store both under the same simulator item in this repository.

Adding new content

Create the following structure for each simulator item:

simulators/<name>/
  README.md
  simulator/
  godot/          # optional

Place the generated simulator package inside simulator/. If a Godot visualization exists, place it inside godot/ and keep any MQTT bridge scripts with the simulator so the item can be run without searching across directories.