Installation

Sionna is composed of three Python modules, namelySionna RT,SionnaPHY, andSionna SYS.

Sionna PHY and Sionna SYS requirePython 3.10-3.12andTensorFlow 2.14-2.19. We recommendUbuntu 24.04. Earlier versions of TensorFlow may still work but are notrecommended. We refer to theTensorFlow GPU supporttutorial for GPU support and therequired driver setup.

Sionna RT has the same requirements asMitsuba 3 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.

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.

TheSionna Research Kit runs on theNVIDIA Jetson AGX Orin platform. We refer to thequickstart guide for a detailed introduction.

Using pip

The recommended way to install Sionna is via pip:

pipinstallsionna

If you want to install only Sionna RT, run:

pipinstallsionna-rt

If you want to install Sionna without the RT package, run:

pipinstallsionna-no-rt

From source

  1. Clone the repository with all submodules:

    gitclone--recursivehttps://github.com/NVlabs/sionna

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

    gitsubmoduleupdate--init--recursive--remote

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

    pipinstallext/sionna-rt/.pipinstall.

Testing

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

pipinstall'.[test]'

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

Documentation

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

pipinstall'.[doc]'

You might need to installpandoc manually.

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

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

python-mhttp.server--dirbuild/html

Developing

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

pipinstall'.[dev]'

Linting of the code can be achieved by runningpylintsrc/ from the repository’s root directory.