Welcome to RANFusion

Overview

RANFusion Simulator is a tool designed to simulate the behavior and performance of 5G network components. Our simulator offers a detailed framework to test and analyze various components of 5G technology, including the RAN functionalities, behavior, and performance of 5G networks, This version (1.0.0) just focuses on handover processes.

Development and Bug Fixes

We are continuously developing and improving RANFusion. Your feedback and contributions are invaluable to us. If you encounter any bugs or have suggestions for new features, please open an issue or submit a pull request. Together, we can make RANFusion even better!

Paper

If you find our work useful, please consider citing our paper:

@misc{natanzi2024ranfusion,
      title={RANFusion: A Comprehensive Tool for Simulating Handover In Next-G RAN}, 
      author={Seyed Bagher Hashemi Natanzi and Bo Tang},
      year={2024},
      eprint={2405.19480},
      archivePrefix={arXiv},
      primaryClass={cs.NI}
}

Sample Results

Initial UE Configuration
Simulation Logs
Command Line menu
InfluxDB GUI for Performance Metrics

Features

Realistic RAN Simulation: Models 5G network elements and protocols accurately.
Multi-Support: For multiple gNodeB, Cells, Sectors, and UEs.
API Enabled: To add, remove, and update UEs with parameters.
CLI/CD Enabled: To see the state of each entity.
Customizable Scenarios: For configuring various network scenarios.
Supported Scenarios: Traffic generation for UEs and soft handover within gNodeB.
Performance Metrics via InfluxDB: Comprehensive metrics for insightful 5G network analysis.

Getting Started

Prerequisites

Operating System: Windows
Python: Version 3.x.
Dependencies: Install InfluxDB and Libraries via pip install -r requirements.txt.

Installation Guide

Clone the Repository: Obtain the project on your machine.
Navigate: Move to the project directory.
InfluxDB Make sure influxDB separately install on you machine
Setup: Execute setup.py and wait.
InfluxDB: Install and setup on your machine.
API Token: Get the API token from InfluxDB GUI (http://localhost:8086/).
Configure: Insert the token into setup.py.
Run: Start the simulation with main.py.
Send command via API: Start a new terminal and past a sample API like add or remove ue.

Documentation

Explore RANFusion further in our documentation.(https://RANFusion.com/doc).

API Sample

To get the list of the all ue:

$response = Invoke-RestMethod -Uri 'http://localhost:5000/api/ues' -Method Get; $response | ConvertTo-Json -Depth 10

To remove a UE, for example, remove "UE10" :

Invoke-RestMethod -Uri 'http://localhost:5000/del_ue' -Method Post -ContentType 'application/json' -Body '{"ue_id": "ue10"}'

To stop a UE traffic, for example, stop "UE1" :

Invoke-RestMethod -Uri "http://localhost:5000/api/stop_ue_traffic" -Method Post -ContentType "application/json" -Body '{"ue_id": "ue1"}'

To update a UE parameter, for example, set "MaxBandwidth" of "UE10" to 150 :

Invoke-RestMethod -Method Post -ContentType "application/json" -Body '{
    "ue_id": "ue10",
    "MaxBandwidth": 150
}' -Uri http://localhost:5000/update_ue

To receive a UE metric, for example, "ue1" :

Invoke-RestMethod -Uri 'http://localhost:5000/api/ue_metrics?ue_id=ue1' -Method Get

To exit from RANFusion:

Invoke-RestMethod -Uri 'http://localhost:5000/api/shutdown' -Method Post

To Remove all information inside the influx db:

Invoke-RestMethod -Uri "http://localhost:5000/flush_database" -Method Post -Headers @{"Content-Type"="application/json"} -Body '{"confirm":"yes"}'

To change a UE traffic, for example, "UE10" :

Invoke-RestMethod -Uri 'http://localhost:5000/set_traffic' -Method Post -ContentType 'application/json' -Body '{"ue_id": "5", "traffic_params": {"throughput": 30}}'

To add a UE for example add "UE11" to sector "AX1112-A1" :

Invoke-RestMethod -Uri 'http://localhost:5000/add_ue' -Method Post -ContentType 'application/json' -Body '{
  "ue_id": "42",
  "service_type": "data",
  "sector_id": "AX1112-A1",
  "gnodeb_id": "",
  "IMEI": "",
  "location": {
    "latitude": 42.2745,
    "longitude": -71.8064
  },
  "connectedCellID": "",
  "isMobile": "",
  "initialSignalStrength": 0.75,
  "rat": "NR",
  "maxBandwidth": 200,
  "duplexMode": "TDD",
  "txPower": 23,
  "modulation": [
    "QPSK"
  ],
  "coding": "LDPC",
  "mimo": "2x2",
  "processing": "Category 4",
  "bandwidthParts": [
    50
  ],
  "channelModel": "TDL-C",
  "velocity": 50,
  "direction": 135,
  "trafficModel": "Full Buffer",
  "schedulingRequests": true,
  "rlcMode": "AM",
  "snrThresholds": [
    18
  ],
  "hoMargin": 6,
  "n310": 1,
  "n311": 5,
  "model": "Iphon14 pro",
  "screensize": "6.12",
  "batterylevel": 80,
  "datasize": ""
}'

natanzi/RAN-Fusion