Skip to content

quickstart.md

Latest commit

 

History

History
81 lines (52 loc) · 1.64 KB

quickstart.md

File metadata and controls

81 lines (52 loc) · 1.64 KB
Raw

Quickstart

This guide aims to get a new user from clone to a visible EmION workflow quickly.

1. Install

From the repository root:

pip install -e ".[dashboard,test]"

If you need the full local environment setup for ION-backed execution, run:

chmod +x install.sh && ./install.sh

2. Verify the Fast Checks

Before opening the dashboard, confirm the scenario and dashboard workflow layer works:

pytest -q tests/test_scenario_import.py tests/test_dashboard_scenarios.py

Expected result:

  • all tests pass
  • custom XML upload/load behavior is validated

3. Launch the Dashboard

emion dashboard

Then open:

http://localhost:8420

4. Load a Scenario

In the dashboard:

  1. Open the SCENARIO ENGINE panel
  2. Upload a scenario XML file
  3. Confirm the scenario briefing appears
  4. Confirm nodes and links appear on the canvas

Good starting files:

  • examples/ion_mars/mars.xml
  • examples/complex_scenarios/hex_ring.xml

5. Start the Scenario

Click Start in the scenario controls.

Expected behavior:

  • the progress state changes
  • node motion begins for scenarios with mobility events
  • link state updates appear in the canvas and telemetry

6. Optional: Run the Full Integration Test

If your environment includes the real ION runtime and supporting tools:

pytest -q tests/test_emion.py

7. Next Steps