Repository files navigation

Sionna™ is an open-source Python-based library for research oncommunication systems.

The official documentation can be foundhere.

It is composed of the following packages:

• Sionna RT -A lightning-fast stand-alone ray tracer for radio propagation modeling

• Sionna PHY -A link-level simulator for wireless and optical communication systems

• Sionna SYS -A system-level simulator based on physical-layer abstraction

Sionna PHY and Sionna SYS requirePython 3.10-3.12 andTensorFlow 2.14-2.19. We recommend Ubuntu 24.04. Earlier versions of TensorFlow may still work but are not recommended. We refer to theTensorFlow GPU support tutorial for GPU support and the required driver setup.

Sionna RT has the same requirements asMitsuba3 and we refer to itsinstallation guide for furtherinformation. To run Sionna RT on CPU,LLVM is required byDr.Jit. Please check theinstallation instructions for the LLVMbackend. The sourcecode of Sionna RT is located in a separateGitHub repository.

If you want to run the tutorial notebooks on your machine, you also needJupyterLab. You can alternatively test them onGoogleColab. Although not necessary, we recommendrunning Sionna in aDocker container and/orPython virtualenviroment.

The recommended way to install Sionna is via pip:

pip install sionna

If you want to install only Sionna RT, run:

pip install sionna-rt

You can install Sionna without the RT package via

pip install sionna-no-rt

1. Clone the repository with all submodules:

   git clone --recursive https://github.com/NVlabs/sionna

   If you have already cloned the repository but forgot to set the--recursiveflag, you can correct this via:

   git submodule update --init --recursive --remote

2. Install Sionna (including Sionna RT) by running the following command from within the repository'sroot folder:

   pip install ext/sionna-rt/ .pip install .

First, you need to install the test requirements by executing thefollowing command from the repository's root directory:

pip install '.[test]'

The unit tests can then be executed by runningpytest from within thetest folder.

Install the requirements for building the documentation by running the followingcommand from the repository's root directory:

pip install '.[doc]'

You might need to installpandoc manually.

You can then build the documentation by executingmake html from within thedoc folder.

The documentation can then be served by any web server, e.g.,

python -m http.server --dir build/html

Development requirements can be installed by executing from the repository's root directory:

pip install '.[dev]'

Linting of the code can be achieved by runningpylint src/ from the repository's root directory.

Sionna is Apache-2.0 licensed, as found in theLICENSE file.

If you use this software, please cite it as:

@software{sionna,title ={Sionna},author ={Hoydis, Jakob and Cammerer, Sebastian and {Ait Aoudia}, Fayçal and Nimier-David, Merlin and Maggi, Lorenzo and Marcus, Guillermo and Vem, Avinash and Keller, Alexander},note ={https://nvlabs.github.io/sionna/},year ={2022},version ={1.2.1}}