<!--
SPDX-FileCopyrightText: Copyright (c) 2021-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: Apache-2.0
-->
# Sionna RT: The Ray Tracing Package of Sionna™
[Sionna RT](https://nvlabs.github.io/sionna-rt) is the stand-alone ray tracing package of the [Sionna™ Library for Research
on Communication Systems](https://github.com/NVlabs/sionna).
It is built on top of [Mitsuba 3](https://github.com/mitsuba-renderer/mitsuba3) and is interoperable with
[TensorFlow](https://www.tensorflow.org/), [PyTorch](https://pytorch.org/), and [JAX](https://jax.readthedocs.io/en/latest/index.html).
The official documentation can be found on the [Sionna
website](https://nvlabs.github.io/sionna/).
## Installation
The recommended way to install Sionna RT is via pip:
```
pip install sionna-rt
```
Sionna RT has the same requirements as Mitsuba 3 and we refer to its
[installation guide](https://mitsuba.readthedocs.io/en/stable/) for further information.
To run Sionna RT on CPU, [LLVM](https://llvm.org) is required by Dr.Jit.
Please check the [installation instructions for the LLVM backend](https://drjit.readthedocs.io/en/latest/what.html#backends).
### Installation from source
After to cloning the repository, you can install
``sionna-rt`` by running the following command from within the repository's root directory:
```
pip install .
```
## Testing
First, you need to install the test requirements by executing the
following command from the repository's root directory:
```
pip install '.[test]'
```
The unit tests can then be executed by running ``pytest`` from within the
``test`` folder.
## Building the Documentation
Install the requirements for building the documentation by running the following
command from the repository's root directory:
```
pip install '.[doc]'
```
You might need to install [pandoc](https://pandoc.org) manually.
You can then build the documentation by executing ``make html`` from within the ``doc`` folder.
The documentation can then be served by any web server, e.g.,
```
python -m http.server --dir build/html
```
## For Developers
The documentation of Sionna RT includes [developer guides](https://nvlabs.github.io/sionna/rt/developer/developer.html)
explaining how to extend it with custom antenna patterns, radio materials, etc.
Development requirements can be installed by executing from the repository's root directory:
```
pip install '.[dev]'
```
Linting of the code can be achieved by running ```pylint src/``` from the
repository's root directory.
## License and Citation
Sionna RT is Apache-2.0 licensed, as found in the [LICENSE](https://github.com/nvlabs/sionna-rt/blob/main/LICENSE) file.
If you use this software, please cite it as:
```bibtex
@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.0}
}
```
Raw data
{
"_id": null,
"home_page": null,
"name": "sionna-rt",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "ray tracing, radio propagation, channel model, coverage map, radio map, wireless communication, differentiable ray tracing, gradient-based optimization, automatic differentiation",
"author": null,
"author_email": "The Sionna contributors <sionna@nvidia.com>",
"download_url": null,
"platform": null,
"description": "<!--\nSPDX-FileCopyrightText: Copyright (c) 2021-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\nSPDX-License-Identifier: Apache-2.0\n-->\n# Sionna RT: The Ray Tracing Package of Sionna™\n\n[Sionna RT](https://nvlabs.github.io/sionna-rt) is the stand-alone ray tracing package of the [Sionna™ Library for Research\non Communication Systems](https://github.com/NVlabs/sionna).\nIt is built on top of [Mitsuba 3](https://github.com/mitsuba-renderer/mitsuba3) and is interoperable with\n[TensorFlow](https://www.tensorflow.org/), [PyTorch](https://pytorch.org/), and [JAX](https://jax.readthedocs.io/en/latest/index.html).\n\nThe official documentation can be found on the [Sionna\nwebsite](https://nvlabs.github.io/sionna/).\n\n\n## Installation\n\nThe recommended way to install Sionna RT is via pip:\n\n```\npip install sionna-rt\n```\n\nSionna RT has the same requirements as Mitsuba 3 and we refer to its\n[installation guide](https://mitsuba.readthedocs.io/en/stable/) for further information.\n\nTo run Sionna RT on CPU, [LLVM](https://llvm.org) is required by Dr.Jit. \nPlease check the [installation instructions for the LLVM backend](https://drjit.readthedocs.io/en/latest/what.html#backends).\n\n### Installation from source\nAfter to cloning the repository, you can install\n``sionna-rt`` by running the following command from within the repository's root directory:\n\n```\npip install .\n```\n\n\n## Testing\nFirst, you need to install the test requirements by executing the\nfollowing command from the repository's root directory:\n\n```\npip install '.[test]'\n```\n\nThe unit tests can then be executed by running ``pytest`` from within the\n``test`` folder.\n\n## Building the Documentation\nInstall the requirements for building the documentation by running the following\ncommand from the repository's root directory:\n\n```\npip install '.[doc]'\n```\n\nYou might need to install [pandoc](https://pandoc.org) manually.\n\nYou can then build the documentation by executing ``make html`` from within the ``doc`` folder.\n\nThe documentation can then be served by any web server, e.g.,\n\n```\npython -m http.server --dir build/html\n```\n\n## For Developers\n\nThe documentation of Sionna RT includes [developer guides](https://nvlabs.github.io/sionna/rt/developer/developer.html)\nexplaining how to extend it with custom antenna patterns, radio materials, etc.\n\nDevelopment requirements can be installed by executing from the repository's root directory:\n\n```\npip install '.[dev]'\n```\n\nLinting of the code can be achieved by running ```pylint src/``` from the\nrepository's root directory.\n\n## License and Citation\n\nSionna RT is Apache-2.0 licensed, as found in the [LICENSE](https://github.com/nvlabs/sionna-rt/blob/main/LICENSE) file.\n\nIf you use this software, please cite it as:\n```bibtex\n@software{sionna,\n title = {Sionna},\n author = {Hoydis, Jakob and Cammerer, Sebastian and {Ait Aoudia}, Fay\u00e7al and Nimier-David, Merlin and Maggi, Lorenzo and Marcus, Guillermo and Vem, Avinash and Keller, Alexander},\n note = {https://nvlabs.github.io/sionna/},\n year = {2022},\n version = {1.2.0}\n}\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Sionna RT - A hardware-accelerated differentiable ray tracer for radio propagation modeling",
"version": "1.2.0",
"project_urls": {
"documentation": "https://nvlabs.github.io/sionna/",
"issues": "https://github.com/nvlabs/sionna/issues",
"source": "https://github.com/nvlabs/sionna-rt/"
},
"split_keywords": [
"ray tracing",
" radio propagation",
" channel model",
" coverage map",
" radio map",
" wireless communication",
" differentiable ray tracing",
" gradient-based optimization",
" automatic differentiation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "23f9558f03472cc2df6a78ed665a20d5c816627f976bcb6e7d0297ae51bd7e4b",
"md5": "7cd02fae5d0b77a79b4da39364a5de28",
"sha256": "96215676c669cab0cd747c8b72b46bf0b64825ecc3224bf5a43e397a7d1245b6"
},
"downloads": -1,
"filename": "sionna_rt-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7cd02fae5d0b77a79b4da39364a5de28",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 8367018,
"upload_time": "2025-09-19T16:32:25",
"upload_time_iso_8601": "2025-09-19T16:32:25.608363Z",
"url": "https://files.pythonhosted.org/packages/23/f9/558f03472cc2df6a78ed665a20d5c816627f976bcb6e7d0297ae51bd7e4b/sionna_rt-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-19 16:32:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nvlabs",
"github_project": "sionna",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sionna-rt"
}
JSON
