Skip to content

Latest commit

 

History

History
84 lines (66 loc) · 3 KB

install.md

File metadata and controls

84 lines (66 loc) · 3 KB
Raw

ns3-ai Installation

This installation works on Ubuntu 22.04 and macOS 13.0 or higher.

Requirements

  1. Boost C++ libraries
    • Ubuntu: sudo apt install libboost-all-dev
    • macOS: brew install boost
  2. Protocol buffers
    • Ubuntu: sudo apt install libprotobuf-dev protobuf-compiler
    • macOS: brew install protobuf
  3. pybind11
    • Ubuntu: sudo apt install pybind11-dev
    • macOS: brew install pybind11
  4. A Python virtual environment dedicated for ns3-ai (highly recommended)
    • Why:
      • Separate your ns3-ai dependencies from your other Python-based projects. (Why being virtual)
      • In build process of ns3-ai examples, Python binding modules are built using system Python libraries (installed with apt or brew), while your scripts are interpreted with environmental Python (possibly created and activated with conda, for your another project). Version mismatch between those Python environments may cause error in your Python script (possibly some modules could not be found). (Why being dedicated)
    • How:
      • Check your version of system-wide installed Python: Find the version of Python in the output of apt list --installed (Ubuntu) or brew list (macOS). If two or more versions are found, keep only one version.
      • Create a conda virtual environment of the same version: conda create -n ns3ai_env python=<version found in previous step>
      • Activate the virtual and dedicated Python environment for ns3-ai: conda activate ns3ai_env

General Setup

  1. Clone this repository at contrib/ai
cd YOUR_NS3_DIRECTORY
git clone https://github.com/hust-diangroup/ns3-ai.git contrib/ai
  1. Configure and build the ai library
./ns3 configure --enable-examples
./ns3 build ai
  1. Setup Python interfaces. It's recommended to use a separate Conda environment for ns3-ai.
pip install -e contrib/ai/python_utils
pip install -e contrib/ai/model/gym-interface/py
  1. Build the examples (optional)

All targets named ns3ai_* can be built separately.

# build all examples in all versions
./ns3 build ns3ai_apb_gym ns3ai_apb_msg_stru ns3ai_apb_msg_vec ns3ai_multibss ns3ai_rltcp_gym ns3ai_rltcp_msg ns3ai_ratecontrol_constant ns3ai_ratecontrol_ts ns3ai_ltecqi_msg

# build A-Plus-B example
# with Gym interface
./ns3 build ns3ai_apb_gym
# with Message interface - struct based
./ns3 build ns3ai_apb_msg_stru
# with Message interface - vector based
./ns3 build ns3ai_apb_msg_vec

# build Multi-BSS example
# with Message interface - vector based
./ns3 build ns3ai_multibss

# build RL-TCP example
# with Gym interface
./ns3 build ns3ai_rltcp_gym
# with Message interface - struct based
./ns3 build ns3ai_rltcp_msg

# build Rate-Control examples
# constant rate example, with Message interface - struct based
./ns3 build ns3ai_ratecontrol_constant
# Thompson Sampling example, with Message interface - struct based
./ns3 build ns3ai_ratecontrol_ts

# build LTE-CQI example
# with Message interface - struct based
./ns3 build ns3ai_ltecqi_msg