RENEWLab

Description

RENEWLab is an open-source software toolbox for the RENEW massive MIMO platform. It provides a user interface through a set of APIs. Users can generate, manipulate, transmit, and receive RF signals on the RENEW hardware by calling these APIs.

The design goal of RENEWLab is to provide the RENEW software library and a quick starting point for users to design, program, and run their experiments on the RENEW massive MIMO platform.

Components

The RENEWLab software suite consists of four components.

1. Python Development Suite: It provides a Python-based library which allows users to rapidly program and test the physical layer and the radio layer in real time. It also provides tools for offline data procesing.

2. MATLAB Development Suite: It provides a MATLAB-based library which allows users to rapidly develop physical layer algorithms using the MATLAB toolboxes with a highly simplified interface and to perform OTA tests. .

3. C++ Development Suite: It provides the Sounder framework for running channel sounding experiments..

4. RENEW Dashboard: It provides a web GUI for the RENEW base station health monitoring and for users to run different software frameworks with ease. Please refer to the README under the WEBGUI/ directory.

Installation

Clone this repository:

$ git clone https://github.com/renew-wireless/RENEWLab.git

Install common dependencies:

$ cd RENEWLab
$ ./config_ci.sh  Note: You must run this command immediately after the cd command if you are a developer.
$ ./install_soapy.sh

Note: This installs the SoapySDR app and its dependencies which include SoapySDR, SoapyRemote, and Sklk-SoapyIris. Note for developers: Do not use _ in your branch name. Use - instead.

Install project-specific dependencies:

1. If you are going to use the RENEW Python Development Suite, please install its library as below.

   $ ./install_pylibs.sh

   Note: The Python packages listed below are needed to use the RENEW Python Development Suite.

   $ sudo apt-get install python-scipy python-h5py python-json python-matplotlib transitions

2. If you are going to use the RENEW C++ Development Suite, please install its library and dependencies as below.

   $ ./install_cclibs.sh
   $ cd CC/Sounder/mufft/
   $ git submodule update --init
   $ cmake -DCMAKE_POSITION_INDEPENDENT_CODE=ON ./ && make -j
   $ cd ../
   $ cmake ./ && make -j

3. If you are going to use the RENEW MATLAB Development Suite, there is no dependency needed for it.

4. If you are going to use the RENEW Dashboard, please follow the README in the WEBGUI/ directory to install dependencies.

Development

Want to contribute? Great! Email [email protected].