UBSim
The Universal Broadband Simulator
Introduction
Placeholder text.
UBSim is placeholder text..
Software & Hardware Prerequisites
Hardware Requirements
None.
Software Requirements
- Python: recommend version 3.10 or later (developed using 3.10.14)
Recommended Tools
- Anaconda: we will provide a default Python environment to enable use of the base simulator release configuration. We recommend users not using Anaconda to reference the environment configuration file for a list of required (and recommended) library dependencies.
Knowledge Prerequisites
We recommend experience with Python 3.8 or above.
We recommend a basic understanding of wireless communications, such as channel properties and signal propagation modeling.
Setup Guide
Installation
Clone the repository, e.g.: git clone git@github.com:WingsLabWireless/ubsim.git
(Recommended) Install and configure Anaconda on the host machine, following publisher instructions. Then, run the following code within the top-level UBSim directory to create the ubsim environment:
-
conda env create --f environmnet.yaml
WARNING: step-by-step documentation beyond this point is still being generated and additional details will be provided ASAP.
Simulation Design
Placeholder text.
API Walkthrough
Placeholder text.
License
UBSim is released under the MIT License.