Skip to content

Getting Started

Learn how to install Risansym and set up your first simulation.

Prerequisites

  • Python 3.10 or higher.
  • (Optional but recommended) uv for lightning-fast package management.

Installation

Install the simulation core directly from PyPI:

uv add risansym
# or using pip
pip install risansym

Creating a Topology

Risansym represents network topologies using standard adjacency-list text files. Create a file named graph.txt:

# Each row represents one node and lists its one-based neighbors.
2
1 3
2

Running the Simulation

You can instantiate the simulator by passing your topology file.

from risansym import Simulation

# Create the simulation engine
engine = Simulation.from_file(
    filename="graph.txt",
    maxtime=100.0,
    algo_name="MyFirstAlgorithm",
    trace_enabled=True,
    trace_dir="traces"
)

# Initialize all models (we haven't attached any yet!)
engine.initialize_all()

# Run the simulation loop
result = engine.run()
assert result.complete
  • trace_enabled: When set to True, the simulation engine will record every event (transmissions, receptions, app logs, and node states) and save it as a JSON file when the simulation finishes.
  • trace_path: You can explicitly set the output file by passing a path string or pathlib.Path instead of using the auto-generated name.

Proceed to Writing Algorithms to learn how to inject behavior into your nodes.