DDLSIM-LAB / DOCUMENTATION

Build. Simulate. Explore.

Documentation and quick-start instructions for installing DDLSim-Lab, running simulations, configuring experiments, and citing the project in academic work.

View on GitHub Quick Start
01

Installation

Clone the repository and install the required dependencies.

Clone the repository and install the required dependencies:

terminal 
git clone https://github.com/ktruby-oss/DDLSim-Lab.git
cd DDLSim-Lab
pip install -r requirements.txt
Once the dependencies are installed, you can move on to running the basic simulation.
02

Running a Simulation

Start with a basic simulation or provide a custom YAML configuration.

Execute the main script to start a basic 2-node simulation with random latency and packet loss:

terminal / basic 
python main.py

Or use an advanced custom YAML configuration:

terminal / configuration 
python main.py --config configs/edge_cloud_hybrid.yaml
Custom YAML configurations can be used when you need more control over the simulation environment.
03

Citation

BibTeX information for academic use of DDLSim-Lab.

If you use DDLSim-Lab in your academic work, please use the following BibTeX citation:

Copy the following entry into your BibTeX bibliography.
BibTeX 
@software{truby2025ddlsimlab,
  author = {Truby, Kaitlyn Brishae},
  title = {DDLSim-Lab: Distributed simulation environment using bare metal nodes},
  year = {2025},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/ktruby-oss/DDLSim-Lab}}
}

Explore the full documentation

Access the project's documentation directory on GitHub for additional project material and resources.

View Full Docs on GitHub