Skip to content

Commit 39e25eb

Browse files
gmarcusmjhoydisfaycalaaSebastianCalollodealma
committed
Release v2.0.0
Signed-off-by: The Sionna Team <sionna@nvidia.com> Merged-by: Guillermo Marcus <4169784+gmarcusm@users.noreply.github.com> Co-authored-by: Jakob Hoydis <5190129+jhoydis@users.noreply.github.com> Co-authored-by: Fayçal Ait-Aoudia <43564757+faycalaa@users.noreply.github.com> Co-authored-by: Sebastian Cammerer <18167671+SebastianCa@users.noreply.github.com> Co-authored-by: Lorenzo Maggi <34341780+lollodealma@users.noreply.github.com> Co-authored-by: Merlin Nimier-David <merlin.nimier@gmail.com> Co-authored-by: Baptiste Nicolet <40777524+bathal1@users.noreply.github.com> Co-authored-by: Guillermo Marcus <4169784+gmarcusm@users.noreply.github.com>
1 parent ce8471a commit 39e25eb

84 files changed

Lines changed: 572 additions & 573 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
SPDX-FileCopyrightText: Copyright (c) 2021-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
SPDX-FileCopyrightText: Copyright (c) 2021-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
33
SPDX-License-Identifier: Apache-2.0
44
-->
55
# Code of Conduct

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
SPDX-FileCopyrightText: Copyright (c) 2021-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
SPDX-FileCopyrightText: Copyright (c) 2021-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
33
SPDX-License-Identifier: Apache-2.0
44
-->
55
# Contributing to Sionna
@@ -59,3 +59,5 @@ Creating a pull request requires the following steps:
5959
6060
(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
6161
```
62+
63+

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
SPDX-FileCopyrightText: Copyright (c) 2021-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
1+
SPDX-FileCopyrightText: Copyright (c) 2021-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
22
SPDX-License-Identifier: Apache-2.0
33

44
Licensed under the Apache License, Version 2.0 (the "License");

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
SPDX-FileCopyrightText: Copyright (c) 2021-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
SPDX-FileCopyrightText: Copyright (c) 2021-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
33
SPDX-License-Identifier: Apache-2.0
44
-->
55
# Sionna RT: The Ray Tracing Package of Sionna&trade;
@@ -24,7 +24,7 @@ pip install sionna-rt
2424
Sionna RT has the same requirements as Mitsuba 3 and we refer to its
2525
[installation guide](https://mitsuba.readthedocs.io/en/stable/) for further information.
2626

27-
To run Sionna RT on CPU, [LLVM](https://llvm.org) is required by Dr.Jit.
27+
To run Sionna RT on CPU, [LLVM](https://llvm.org) is required by Dr.Jit.
2828
Please check the [installation instructions for the LLVM backend](https://drjit.readthedocs.io/en/latest/what.html#backends).
2929

3030
### Installation from source
@@ -90,6 +90,6 @@ If you use this software, please cite it as:
9090
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},
9191
note = {https://nvlabs.github.io/sionna/},
9292
year = {2022},
93-
version = {1.2.2}
93+
version = {2.0.0}
9494
}
9595
```

SECURITY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
SPDX-FileCopyrightText: Copyright (c) 2021-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
SPDX-FileCopyrightText: Copyright (c) 2021-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
33
SPDX-License-Identifier: Apache-2.0
44
-->
55
# Reporting vulnerabilities
@@ -15,4 +15,4 @@ In addition, please include the following information along with your report:
1515
- An explanation who can exploit this vulnerability, and what they gain when doing so -- write an attack scenario. This will help us evaluate your report quickly, especially if the issue is complex.
1616
- Whether this vulnerability public or known to third parties. If it is, please provide details.
1717

18-
If you believe that an existing (public) issue is security-related, please send an email to `sionna@nvidia.com`. The email should include the issue ID and a short description of why it should be handled according as a security issue.
18+
If you believe that an existing (public) issue is security-related, please send an email to `sionna@nvidia.com`. The email should include the issue ID and a short description of why it should be handled according as a security issue.

doc/source/_static/css/sionna.css

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
SPDX-FileCopyrightText: Copyright (c) 2021-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
SPDX-FileCopyrightText: Copyright (c) 2021-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
33
SPDX-License-Identifier: Apache-2.0
44
*/
55
.wy-side-nav-search {
@@ -60,4 +60,4 @@ div.math {
6060
max-width: 100%;
6161
overflow-x: auto;
6262
overflow-y: hidden;
63-
}
63+
}

doc/source/api/antenna_pattern.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,3 @@ Utility Functions
3939
.. autofunction:: sionna.rt.register_antenna_pattern
4040
.. autofunction:: sionna.rt.register_polarization
4141
.. autofunction:: sionna.rt.register_polarization_model
42-
43-
References:
44-
.. [Balanis97] A\. Balanis, "Antenna Theory: Analysis and Design," 2nd Edition, John Wiley & Sons, 1997.
45-
.. [TR38901] 3GPP TR 38.901, "`Study on channel model for frequencies from 0.5
46-
to 100 GHz <https://portal.3gpp.org/desktopmodules/Specifications/SpecificationDetails.aspx?specificationId=3173>`_", Release 18.0

doc/source/api/paths.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,3 @@ Constants
2626

2727
.. autodata:: sionna.rt.constants.INVALID_SHAPE
2828
.. autodata:: sionna.rt.constants.INVALID_PRIMITIVE
29-
30-
References:
31-
.. [Wiffen2018] F\. Wiffen et al., "`Comparison of OTFS and OFDM in Ray Launched sub-6 GHz and mmWave Line-of-Sight Mobility Channels <https://ieeexplore.ieee.org/abstract/document/8580850>`_", Proc. IEEE Int. Sym. Personal, Indoor and Mobile Radio Commun. (PIMRC), Bologna, Italy, Sep. 2018.

doc/source/api/radio_materials.rst

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ is modeled in Sionna RT as a planar surface whose radio material describes the
3939
desired thickness.
4040

4141
Additionally, a :class:`~sionna.rt.RadioMaterial` can have an effective roughness (ER)
42-
associated with it, leading to diffuse reflections (see, e.g., [Degli-Esposti11]_).
42+
associated with it, leading to diffuse reflections (see, e.g., :cite:p:`Degli-Esposti11`).
4343
The ER model requires a scattering coefficient :math:`S\in[0,1]` :eq:`scattering_coefficient`,
4444
a cross-polarization discrimination coefficient :math:`K_x` :eq:`xpd`, as well as a scattering pattern
4545
:math:`f_\text{s}(\hat{\mathbf{k}}_\text{i}, \hat{\mathbf{k}}_\text{s})` :eq:`lambertian_model`--:eq:`backscattering_model`, such as the
@@ -53,21 +53,21 @@ are automatically updated according to the configured :attr:`~sionna.rt.Scene.fr
5353
.. _provided-materials:
5454

5555
Through the :class:`~sionna.rt.ITURadioMaterial` class, Sionna provides the models of all of the materials
56-
defined in the ITU-R P.2040-3 recommendation [ITU_R_2040_3]_. These models are based on curve fitting to
56+
defined in the ITU-R P.2040-3 recommendation :cite:p:`ITURP20403`. These models are based on curve fitting to
5757
measurement results and assume non-ionized and non-magnetic materials
5858
(:math:`\mu_r = 1`).
5959
Frequency dependence is modeled by
6060

6161
.. math::
62-
\begin{align}
62+
\begin{aligned}
6363
\varepsilon_r &= a f_{\text{GHz}}^b\\
6464
\sigma &= c f_{\text{GHz}}^d
65-
\end{align}
65+
\end{aligned}
6666
6767
where :math:`f_{\text{GHz}}` is the frequency in GHz, and the constants
6868
:math:`a`, :math:`b`, :math:`c`, and :math:`d` characterize the material.
6969
The table below provides their values which are used in Sionna
70-
(from [ITU_R_2040_3]_).
70+
(from :cite:p:`ITURP20403`).
7171
Note that the relative permittivity :math:`\varepsilon_r` and
7272
conductivity :math:`\sigma` of all materials are updated automatically when
7373
the frequency is set through the scene's property :class:`~sionna.rt.Scene.frequency`.
@@ -148,6 +148,3 @@ Scattering Patterns
148148

149149
.. autofunction:: sionna.rt.register_scattering_pattern
150150

151-
References:
152-
.. [Degli-Esposti11] V\. Degli-Esposti et al., "`Analysis and Modeling on co- and Cross-Polarized Urban Radio Propagation for Dual-Polarized MIMO Wireless Systems <https://ieeexplore.ieee.org/abstract/document/5979177>`_", IEEE Trans. Antennas Propag, vol. 59, no. 11, pp.4247-4256, Nov. 2011.
153-
.. [ITU_R_2040_3] Recommendation ITU-R P.2040-3, "`Effects of building materials and structures on radiowave propagation above about 100 MHz <https://www.itu.int/rec/R-REC-P.2040-3-202308-I/en>`_"

doc/source/api/utils.rst

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,3 @@ Ray tracing
6565
.. autofunction:: sionna.rt.utils.spawn_ray_to
6666

6767

68-
References:
69-
.. [ITU_R_2040_3] Recommendation ITU-R P.2040-3, "`Effects of building materials
70-
and structures on radiowave propagation above about 100 MHz
71-
<https://www.itu.int/rec/R-REC-P.2040-3-202308-I/en>`_"
72-
.. [ITU_R_P_526_15] Recommendation ITU-R P.526-15, "`Propagation by
73-
diffraction <https://www.itu.int/rec/R-REC-P.526-15-201910-I/en>`_"
74-
.. [TR38901] 3GPP TR 38.901, "`Study on channel model for frequencies from 0.5
75-
to 100 GHz <https://portal.3gpp.org/desktopmodules/Specifications/SpecificationDetails.aspx?specificationId=3173>`_", Release 18.0

0 commit comments

Comments
 (0)