Release v1.0.2

gmarcusm · jhoydis · faycalaa · gmarcusm · commit d1fc7f49c51b · 2025-04-03T16:54:15.000+02:00
Signed-off-by: The Sionna Team &lt;sionna@nvidia.com&gt;
Merged-by: Guillermo Marcus &lt;4169784+gmarcusm@users.noreply.github.com&gt;

Co-authored-by: Jakob Hoydis &lt;5190129+jhoydis@users.noreply.github.com&gt;
Co-authored-by: Fayçal Ait-Aoudia &lt;43564757+faycalaa@users.noreply.github.com&gt;
Co-authored-by: Sebastian Cammerer &lt;18167671+SebastianCa@users.noreply.github.com&gt;
Co-authored-by: Lorenzo Maggi &lt;34341780+lollodealma@users.noreply.github.com&gt;
Co-authored-by: Merlin Nimier-David &lt;merlin.nimier@gmail.com&gt;
Co-authored-by: Guillermo Marcus &lt;4169784+gmarcusm@users.noreply.github.com&gt;
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -47,7 +47,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -58,7 +58,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -72,4 +72,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3
diff --git a/.github/workflows/pylint.yml b/.github/workflows/pylint.yml
@@ -57,7 +57,7 @@ jobs:
         continue-on-error: true
 
       - name: Upload pylint results to GitHub
-        uses: github/codeql-action/upload-sarif@v2
+        uses: github/codeql-action/upload-sarif@v3
         with:
           sarif_file: pylint.sarif
           wait-for-processing: true
diff --git a/MANIFEST.in b/MANIFEST.in
diff --git a/Makefile b/Makefile
diff --git a/README.md b/README.md
@@ -122,6 +122,6 @@ If you use this software, please cite it as:
  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.0.1}
+ version = {1.0.2}
 }
 ```
diff --git a/doc/source/citation.rst b/doc/source/citation.rst
@@ -11,5 +11,5 @@ If you use this software, please cite it as:
     Alexander},
     note = {https://nvlabs.github.io/sionna/},
     year = {2022},
-    version = {1.0.1}
+    version = {1.0.2}
    }
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -82,19 +82,42 @@
 # Add a custom prolog to each notebook to automatically add github/colab/download links
 nbsphinx_prolog = r"""
 {% set docname = env.doc2path(env.docname, base=None) %}
+{% set fullpath = env.doc2path(env.docname, base='source') %}
+{% set path_parts = fullpath.split('/') %}
+{% set module_name = path_parts[-3] if path_parts|length > 2 else '' %}
+{% set notebook_name = path_parts[-1] if path_parts|length > 1 else '' %}
+
+{# Set the appropriate links based on module name #}
+{% if module_name == 'phy' %}
+    {% set github_link = 'https://github.com/nvlabs/sionna/blob/main/tutorials/phy/' + notebook_name|string|e %}
+    {% set download_link = notebook_name|string|e %}
+    {% set colab_link = 'https://colab.research.google.com/github/nvlabs/sionna/blob/main/tutorials/phy/' + notebook_name|string|e %}
+{% elif module_name == 'sys' %}
+    {% set github_link = 'https://github.com/nvlabs/sionna/blob/main/tutorials/sys/' + notebook_name|string|e %}
+ {% set download_link = notebook_name|string|e %}
+    {% set colab_link = 'https://colab.research.google.com/github/nvlabs/sionna/blob/main/tutorials/sys/' + notebook_name|string|e %}
+{% elif module_name == 'rt' %}
+    {% set github_link = 'https://github.com/nvlabs/sionna-rt/blob/main/tutorials/' + notebook_name|string|e %}
+    {% set download_link = notebook_name|string|e %}
+    {% set colab_link = 'https://colab.research.google.com/github/nvlabs/sionna-rt/blob/main/tutorials/' + notebook_name|string|e %}
+{% else %}
+    {% set github_link = notebook_name|string|e %}
+    {% set download_link = notebook_name|string|e %}
+    {% set colab_link = notebook_name|string|e %}
+{% endif %}
 
 .. raw:: html
 
     <style>h3 {display: block !important}</style>
     <div style="margin-bottom:15px;">
         <table>
             <td style="padding: 0px 0px;">
-                <a href=" https://colab.research.google.com/github/NVlabs/sionna/blob/main/{{ docname|e }}" style="vertical-align:text-bottom">
+                <a href="{{ colab_link }}" style="vertical-align:text-bottom">
                     <img alt="Colab logo" src="../../_static/colab_logo.svg" style="width: 40px; min-width: 40px">
                 </a>
             </td>
             <td style="padding: 4px 0px;">
-                <a href=" https://colab.research.google.com/github/nvlabs/sionna/blob/main/{{ docname|e }}" style="vertical-align:text-bottom">
+                <a href="{{ colab_link }}" style="vertical-align:text-bottom">
                     Run in Google Colab
                 </a>
             </td>
@@ -103,14 +126,14 @@
             </td>
 
             <td class="wy-breadcrumbs-aside" style="padding: 0 30px;">
-                <a href="https://github.com/nvlabs/sionna/blob/main/{{ docname|e }}" style="vertical-align:text-bottom">
+                <a href="{{ github_link }}" style="vertical-align:text-bottom">
                     <i class="fa fa-github" style="font-size:24px;"></i>
                     View on GitHub
                 </a>
             </td>
 
             <td class="wy-breadcrumbs-aside" style="padding: 0 35px;">
-                <a href="../{{ docname|e }}" download target="_blank" style="vertical-align:text-bottom">
+                <a href="{{ download_link|e }}" download target="_blank" style="vertical-align:text-bottom">
                     <i class="fa fa-download" style="font-size:24px;"></i>
                     Download notebook
                 </a>
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -41,6 +41,15 @@ Sionna is developed, continuously extended, and used by NVIDIA to drive 5G and 6
    Contribute <https://github.com/NVlabs/sionna/pulls>
    citation
 
+.. toctree::
+   :name: old-docs
+   :caption: Older Versions
+   :maxdepth: 1
+   :hidden:
+   
+   v0.19.2 <https://jhoydis.github.io/sionna-0.19.2-doc>
+
+
 License
 *******
 Sionna is Apache-2.0 licensed, as found in the `LICENSE <https://github.com/nvlabs/sionna/blob/main/LICENSE>`_ file.
diff --git a/ext/sionna-rt b/ext/sionna-rt
@@ -1 +1 @@
-Subproject commit d0429340b2ee3848e48ed648db9a014dfba22cc8
+Subproject commit f3a944cbb7b4945975fad21353413b3b7c8a477e
diff --git a/pyproject.toml b/pyproject.toml
@@ -15,7 +15,7 @@ exclude = ["sionna.rt*"]
 
 [project]
 name = "sionna"
-version = "1.0.1"
+version = "1.0.2"
 description = "Sionna - A hardware-accelerated differentiable open-source library for research on communication systems"
 readme = "README.md"
 license = {text = "Apache-2.0"}
@@ -51,7 +51,7 @@ classifiers = [
 ]
 requires-python = ">=3.8"
 dependencies = [
-    "sionna-rt==1.0.1",
+    "sionna-rt==1.0.2",
     "tensorflow(>=2.14, !=2.16, !=2.17)",
     "numpy(>=1.26, <2.0)",
     "scipy>=1.14.1",
diff --git a/src/sionna/__init__.py b/src/sionna/__init__.py
@@ -5,7 +5,7 @@
 
 import importlib
 
-__version__ = "1.0.1"
+__version__ = "1.0.2"
 
 # pylint: disable=invalid-name
 def __getattr__(name):
diff --git a/src/sionna/phy/fec/ldpc/decoding.py b/src/sionna/phy/fec/ldpc/decoding.py
@@ -26,32 +26,32 @@ class LDPCBPDecoder(Block):
     (1) `boxplus`
 
         .. math::
-            y_{j \to i} = 2 \operatorname{tanh}^{-1} \left( \prod_{i' \in \mathcal{N}_(j) \setminus i} \operatorname{tanh} \left( \frac{x_{i' \to j}}{2} \right) \right)
+            y_{j \to i} = 2 \operatorname{tanh}^{-1} \left( \prod_{i' \in \mathcal{N}(j) \setminus i} \operatorname{tanh} \left( \frac{x_{i' \to j}}{2} \right) \right)
 
     (2) `boxplus-phi`
 
         .. math::
-            y_{j \to i} = \alpha_{j \to i} \cdot \phi \left( \sum_{i' \in \mathcal{N}_(j) \setminus i} \phi \left( |x_{i' \to j}|\right) \right)
+            y_{j \to i} = \alpha_{j \to i} \cdot \phi \left( \sum_{i' \in \mathcal{N}(j) \setminus i} \phi \left( |x_{i' \to j}|\right) \right)
 
         with :math:`\phi(x)=-\operatorname{log}(\operatorname{tanh} \left(\frac{x}{2}) \right)`
 
     (3) `minsum`
 
         .. math::
-            \qquad y_{j \to i} = \alpha_{j \to i} \cdot {min}_{i' \in \mathcal{N}_(j) \setminus i} \left(|x_{i' \to j}|\right)
+            \qquad y_{j \to i} = \alpha_{j \to i} \cdot {min}_{i' \in \mathcal{N}(j) \setminus i} \left(|x_{i' \to j}|\right)
 
     (4) `offset-minsum`
 
     .. math::
-            \qquad y_{j \to i} = \alpha_{j \to i} \cdot {max} \left( {min}_{i' \in \mathcal{N}_(j) \setminus i} \left(|x_{i' \to j}| \right)-\beta , 0\right)
+            \qquad y_{j \to i} = \alpha_{j \to i} \cdot {max} \left( {min}_{i' \in \mathcal{N}(j) \setminus i} \left(|x_{i' \to j}| \right)-\beta , 0\right)
 
     where :math:`\beta=0.5` and and :math:`y_{j \to i}` denotes the message
     from check node (CN) *j* to variable node (VN) *i* and :math:`x_{i \to j}`
-    from VN *i* to CN *j*, respectively.  Further, :math:`\mathcal{N}_(j)`
+    from VN *i* to CN *j*, respectively.  Further, :math:`\mathcal{N}(j)`
     denotes all indices of connected VNs to CN *j* and
 
     .. math::
-        \alpha_{j \to i} = \prod_{i' \in \mathcal{N}_(j) \setminus i} \operatorname{sign}(x_{i' \to j})
+        \alpha_{j \to i} = \prod_{i' \in \mathcal{N}(j) \setminus i} \operatorname{sign}(x_{i' \to j})
 
     is the sign of the outgoing message. For further details we refer to
     [Ryan]_ and [Chen]_ for offset corrected minsum.
@@ -210,6 +210,10 @@ def __init__(self,
         else:
             raise TypeError("Unsupported dtype of pcm.")
 
+        # Deprecation warning for cn_type
+        if 'cn_type' in kwargs:
+            raise TypeError("'cn_type' is deprecated; use 'cn_update' instead.")
+
         # init decoder parameters
         self._pcm = pcm
         self._hard_out = hard_out
@@ -755,15 +759,15 @@ def cn_update_offset_minsum(msg_v2c_rag, llr_clipping=None, offset=0.5):
     The function implements
 
     .. math::
-            \qquad y_{j \to i} = \alpha_{j \to i} \cdot {max} \left( {min}_{i' \in \mathcal{N}_(j) \setminus i} \left(|x_{i' \to j}| \right)-\beta , 0\right)
+            \qquad y_{j \to i} = \alpha_{j \to i} \cdot {max} \left( {min}_{i' \in \mathcal{N}(j) \setminus i} \left(|x_{i' \to j}| \right)-\beta , 0\right)
 
     where :math:`\beta=0.5` and :math:`y_{j \to i}` denotes the message from
     check node (CN) *j* to variable node (VN) *i* and :math:`x_{i \to j}` from
-    VN *i* to CN *j*, respectively. Further, :math:`\mathcal{N}_(j)` denotes
+    VN *i* to CN *j*, respectively. Further, :math:`\mathcal{N}(j)` denotes
     all indices of connected VNs to CN *j* and
 
     .. math::
-        \alpha_{j \to i} = \prod_{i' \in \mathcal{N}_(j) \setminus i} \operatorname{sign}(x_{i' \to j})
+        \alpha_{j \to i} = \prod_{i' \in \mathcal{N}(j) \setminus i} \operatorname{sign}(x_{i' \to j})
 
     is the sign of the outgoing message. For further details we refer to
     [Chen]_.
@@ -911,15 +915,15 @@ def cn_update_minsum(msg_v2c_rag, llr_clipping=None):
     The function implements
 
     .. math::
-            \qquad y_{j \to i} = \alpha_{j \to i} \cdot {min}_{i' \in \mathcal{N}_(j) \setminus i} \left(|x_{i' \to j}|\right)
+            \qquad y_{j \to i} = \alpha_{j \to i} \cdot {min}_{i' \in \mathcal{N}(j) \setminus i} \left(|x_{i' \to j}|\right)
 
     where :math:`y_{j \to i}` denotes the message from check node (CN) *j* to
     variable node (VN) *i* and :math:`x_{i \to j}` from VN *i* to CN *j*,
-    respectively. Further, :math:`\mathcal{N}_(j)` denotes all indices of
+    respectively. Further, :math:`\mathcal{N}(j)` denotes all indices of
     connected VNs to CN *j* and
 
     .. math::
-        \alpha_{j \to i} = \prod_{i' \in \mathcal{N}_(j) \setminus i} \operatorname{sign}(x_{i' \to j})
+        \alpha_{j \to i} = \prod_{i' \in \mathcal{N}(j) \setminus i} \operatorname{sign}(x_{i' \to j})
 
     is the sign of the outgoing message. For further details we refer to
     [Ryan]_ and [Chen]_.
@@ -960,15 +964,15 @@ def cn_update_tanh(msg, llr_clipping=None):
     The function implements
 
     .. math::
-            y_{j \to i} = 2 \operatorname{tanh}^{-1} \left( \prod_{i' \in \mathcal{N}_(j) \setminus i} \operatorname{tanh} \left( \frac{x_{i' \to j}}{2} \right) \right)
+            y_{j \to i} = 2 \operatorname{tanh}^{-1} \left( \prod_{i' \in \mathcal{N}(j) \setminus i} \operatorname{tanh} \left( \frac{x_{i' \to j}}{2} \right) \right)
 
     where :math:`y_{j \to i}` denotes the message from check node (CN) *j* to
     variable node (VN) *i* and :math:`x_{i \to j}` from VN *i* to CN *j*,
-    respectively. Further, :math:`\mathcal{N}_(j)` denotes all indices of
+    respectively. Further, :math:`\mathcal{N}(j)` denotes all indices of
     connected VNs to CN *j* and
 
     .. math::
-        \alpha_{j \to i} = \prod_{i' \in \mathcal{N}_(j) \setminus i} \operatorname{sign}(x_{i' \to j})
+        \alpha_{j \to i} = \prod_{i' \in \mathcal{N}(j) \setminus i} \operatorname{sign}(x_{i' \to j})
 
     is the sign of the outgoing message. For further details we refer to
     [Ryan]_.
@@ -1052,16 +1056,16 @@ def cn_update_phi(msg, llr_clipping=None):
     The function implements
 
     .. math::
-            y_{j \to i} = \alpha_{j \to i} \cdot \phi \left( \sum_{i' \in \mathcal{N}_(j) \setminus i} \phi \left( |x_{i' \to j}|\right) \right)
+            y_{j \to i} = \alpha_{j \to i} \cdot \phi \left( \sum_{i' \in \mathcal{N}(j) \setminus i} \phi \left( |x_{i' \to j}|\right) \right)
 
     where :math:`\phi(x)=-\operatorname{log}(\operatorname{tanh} \left(\frac{x} {2}) \right)`
     and :math:`y_{j \to i}` denotes the message from check node
     (CN) *j* to variable node (VN) *i* and :math:`x_{i \to j}` from VN *i* to
-    CN *j*, respectively. Further, :math:`\mathcal{N}_(j)` denotes all indices
+    CN *j*, respectively. Further, :math:`\mathcal{N}(j)` denotes all indices
     of connected VNs to CN *j* and
 
     .. math::
-        \alpha_{j \to i} = \prod_{i' \in \mathcal{N}_(j) \setminus i} \operatorname{sign}(x_{i' \to j})
+        \alpha_{j \to i} = \prod_{i' \in \mathcal{N}(j) \setminus i} \operatorname{sign}(x_{i' \to j})
 
     is the sign of the outgoing message. For further details we refer to
     [Ryan]_.
@@ -1326,6 +1330,10 @@ def __init__(self,
             raise TypeError('return_state must be bool.')
         self._return_state = return_state
 
+        # Deprecation warning for cn_type
+        if 'cn_type' in kwargs:
+            raise TypeError("'cn_type' is deprecated; use 'cn_update' instead.")
+
         # prune punctured degree-1 VNs and connected CNs. A punctured
         # VN-1 node will always "send" llr=0 to the connected CN. Thus, this
         # CN will only send 0 messages to all other VNs, i.e., does not
diff --git a/src/sionna/phy/fec/ldpc/utils.py b/src/sionna/phy/fec/ldpc/utils.py
@@ -161,7 +161,7 @@ class WeightedBPCallback(Object):
     leading to
 
     .. math::
-        y_{j \to i} = 2 \operatorname{tanh}^{-1} \left( \prod_{i' \in \mathcal{N}_(j) \setminus i} \operatorname{tanh} \left( \frac{\textcolor{red}{w_{i' \to j}} \cdot x_{i' \to j}}{2} \right) \right)
+        y_{j \to i} = 2 \operatorname{tanh}^{-1} \left( \prod_{i' \in \mathcal{N}(j) \setminus i} \operatorname{tanh} \left( \frac{\textcolor{red}{w_{i' \to j}} \cdot x_{i' \to j}}{2} \right) \right)
 
     where :math:`w_{i \to j}` denotes the trainable weight of message
     :math:`x_{i \to j}`.

Original file line number	Diff line number	Diff line change
`@@ -122,6 +122,6 @@ If you use this software, please cite it as:`
`122`	`122`	`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},`
`123`	`123`	`note = {https://nvlabs.github.io/sionna/},`
`124`	`124`	`year = {2022},`
`125`		`- version = {1.0.1}`
	`125`	`+ version = {1.0.2}`
`126`	`126`	`}`
`127`	`127`	```
Original file line number	Diff line number	Diff line change
`@@ -11,5 +11,5 @@ If you use this software, please cite it as:`
`11`	`11`	`Alexander},`
`12`	`12`	`note = {https://nvlabs.github.io/sionna/},`
`13`	`13`	`year = {2022},`
`14`		`- version = {1.0.1}`
	`14`	`+ version = {1.0.2}`
`15`	`15`	`}`