Release v0.14.0

Signed-off-by: The Sionna Team <sionna@nvidia.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: Guillermo Marcus <4169784+gmarcusm@users.noreply.github.com>
Co-authored-by: Merlin Nimier-David <merlin.nimier@gmail.com>

Merged-by: Guillermo Marcus <4169784+gmarcusm@users.noreply.github.com>

.gitignore

@@ -11,5 +11,11 @@ __pycache__
 .logs
 dev
 _build
+
 doc/build
+# Notebooks copied during doc build
+doc/source/examples/*.ipynb
+
 projects/
+nohup.out
+/*.obj

.gitlab/docker/test-sionna/tf-2.10.1/Dockerfile

@@ -0,0 +1,9 @@
+FROM gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/tensorflow:2.10.1-gpu-jupyter
+
+ENV NVIDIA_DRIVER_CAPABILITIES=all
+
+ADD requirements-2.10.1.txt .
+ADD requirements_test.txt .
+RUN pip3 --proxy http://repox.mi.nvidia.com:3128 install -r requirements-2.10.1.txt && \
+  pip3 --proxy http://repox.mi.nvidia.com:3128 install -r requirements_test.txt && \
+  rm requirements_test.txt requirements-2.10.1.txt

.gitlab/docker/test-sionna/tf-2.10.1/requirements-2.10.1.txt

@@ -0,0 +1,9 @@
+tensorflow==2.10.1
+numpy
+scipy >=1.6.0
+matplotlib
+importlib_resources
+mitsuba >= 3.2.0
+pythreejs >= 2.4.2
+ipywidgets >= 8.0.4
+ipydatawidgets == 4.3.2

.gitlab/docker/test-sionna/tf-2.10.1/requirements_test.txt

@@ -0,0 +1 @@
+pytest

.gitlab/docker/test-sionna/tf-2.11.0/Dockerfile

@@ -0,0 +1,9 @@
+FROM gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/tensorflow:2.11.0-gpu-jupyter
+
+ENV NVIDIA_DRIVER_CAPABILITIES=all
+
+ADD requirements-2.11.0.txt .
+ADD requirements_test.txt .
+RUN pip3 --proxy http://repox.mi.nvidia.com:3128 install -r requirements-2.11.0.txt && \
+  pip3 --proxy http://repox.mi.nvidia.com:3128 install -r requirements_test.txt && \
+  rm requirements_test.txt requirements-2.11.0.txt

.gitlab/docker/test-sionna/tf-2.11.0/requirements-2.11.0.txt

@@ -0,0 +1,9 @@
+tensorflow==2.11.0
+numpy
+scipy >=1.6.0
+matplotlib
+importlib_resources
+mitsuba >= 3.2.0
+pythreejs >= 2.4.2
+ipywidgets >= 8.0.4
+ipydatawidgets == 4.3.2

.gitlab/docker/test-sionna/tf-2.11.0/requirements_test.txt

@@ -0,0 +1 @@
+pytest

.gitlab/docker/test-sionna/tf-2.8.4/Dockerfile

@@ -0,0 +1,9 @@
+FROM gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/tensorflow:2.8.4-gpu-jupyter
+
+ENV NVIDIA_DRIVER_CAPABILITIES=all
+
+ADD requirements-2.8.4.txt .
+ADD requirements_test.txt .
+RUN pip3 --proxy http://repox.mi.nvidia.com:3128 install -r requirements-2.8.4.txt && \
+  pip3 --proxy http://repox.mi.nvidia.com:3128 install -r requirements_test.txt && \
+  rm requirements_test.txt requirements-2.8.4.txt

.gitlab/docker/test-sionna/tf-2.8.4/requirements-2.8.4.txt

@@ -0,0 +1,9 @@
+tensorflow==2.8.4
+numpy
+scipy >=1.6.0
+matplotlib
+importlib_resources
+mitsuba >= 3.2.0
+pythreejs >= 2.4.2
+ipywidgets >= 8.0.4
+ipydatawidgets == 4.3.2

.gitlab/docker/test-sionna/tf-2.8.4/requirements_test.txt

@@ -0,0 +1 @@
+pytest

.gitlab/docker/test-sionna/tf-2.9.3/Dockerfile

@@ -0,0 +1,9 @@
+FROM gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/tensorflow:2.9.3-gpu-jupyter
+
+ENV NVIDIA_DRIVER_CAPABILITIES=all
+
+ADD requirements-2.9.3.txt .
+ADD requirements_test.txt .
+RUN pip3 --proxy http://repox.mi.nvidia.com:3128 install -r requirements-2.9.3.txt && \
+  pip3 --proxy http://repox.mi.nvidia.com:3128 install -r requirements_test.txt && \
+  rm requirements_test.txt requirements-2.9.3.txt

.gitlab/docker/test-sionna/tf-2.9.3/requirements-2.9.3.txt

@@ -0,0 +1,9 @@
+tensorflow==2.9.3
+numpy
+scipy >=1.6.0
+matplotlib
+importlib_resources
+mitsuba >= 3.2.0
+pythreejs >= 2.4.2
+ipywidgets >= 8.0.4
+ipydatawidgets == 4.3.2

.gitlab/docker/test-sionna/tf-2.9.3/requirements_test.txt

@@ -0,0 +1 @@
+pytest

.gitlab/gitlab-ci.yml

@@ -0,0 +1,209 @@
+##
+## SPDX-FileCopyrightText: Copyright (c) 2021-2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+## SPDX-License-Identifier: Apache-2.0
+##
+stages:
+  - build
+  - test
+docker-test-sionna-tf-2.8:
+  stage: build
+  image: 
+    name: gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/docker:23.0.1
+  variables:
+    DOCKER_TLS_CERTDIR: ""
+    DOCKER_HOST: tcp://dockerhost:2375
+  services:
+    - name: gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/docker:23.0.1-dind
+      alias: dockerhost
+  before_script:
+    - mkdir -p /root/.docker || IGNORE_FAILURE=true
+    - echo "$DOCKER_AUTH_CONFIG" > ~/.docker/config.json
+  script:
+    - cd ${CI_PROJECT_DIR}/.gitlab/docker/test-sionna/tf-2.8.4
+    - docker build -t gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/test-sionna-tensorflow:2.8.4-gpu-jupyter -f Dockerfile .
+    - docker push gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/test-sionna-tensorflow:2.8.4-gpu-jupyter
+  tags:
+    - dind
+  rules:
+    - changes:
+        - .gitlab/docker/test-sionna/tf-2.8.4/*
+  when: manual
+
+docker-test-sionna-tf-2.9:
+  stage: build
+  image: 
+    name: gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/docker:23.0.1
+  variables:
+    DOCKER_TLS_CERTDIR: ""
+    DOCKER_HOST: tcp://dockerhost:2375
+  services:
+    - name: gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/docker:23.0.1-dind
+      alias: dockerhost
+  before_script:
+    - mkdir -p /root/.docker || IGNORE_FAILURE=true
+    - echo "$DOCKER_AUTH_CONFIG" > ~/.docker/config.json
+  script:
+    - cd ${CI_PROJECT_DIR}/.gitlab/docker/test-sionna/tf-2.9.3
+    - docker build -t gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/test-sionna-tensorflow:2.9.3-gpu-jupyter -f Dockerfile .
+    - docker push gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/test-sionna-tensorflow:2.9.3-gpu-jupyter
+  tags:
+    - dind
+  rules:
+    - changes:
+        - .gitlab/docker/test-sionna/tf-2.9.3/*
+  when: manual
+
+docker-test-sionna-tf-2.10:
+  stage: build
+  image: 
+    name: gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/docker:23.0.1
+  variables:
+    DOCKER_TLS_CERTDIR: ""
+    DOCKER_HOST: tcp://dockerhost:2375
+  services:
+    - name: gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/docker:23.0.1-dind
+      alias: dockerhost
+  before_script:
+    - mkdir -p /root/.docker || IGNORE_FAILURE=true
+    - echo "$DOCKER_AUTH_CONFIG" > ~/.docker/config.json
+  script:
+    - cd ${CI_PROJECT_DIR}/.gitlab/docker/test-sionna/tf-2.10.1
+    - docker build -t gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/test-sionna-tensorflow:2.10.1-gpu-jupyter -f Dockerfile .
+    - docker push gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/test-sionna-tensorflow:2.10.1-gpu-jupyter
+  tags:
+    - dind
+  rules:
+    - changes:
+        - .gitlab/docker/test-sionna/tf-2.10.1/*
+  when: manual
+
+docker-test-sionna-tf-2.11:
+  stage: build
+  image: 
+    name: gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/docker:23.0.1
+  variables:
+    DOCKER_TLS_CERTDIR: ""
+    DOCKER_HOST: tcp://dockerhost:2375
+  services:
+    - name: gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/docker:23.0.1-dind
+      alias: dockerhost
+  before_script:
+    - mkdir -p /root/.docker || IGNORE_FAILURE=true
+    - echo "$DOCKER_AUTH_CONFIG" > ~/.docker/config.json
+  script:
+    - cd ${CI_PROJECT_DIR}/.gitlab/docker/test-sionna/tf-2.11.0
+    - docker build -t gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/test-sionna-tensorflow:2.11.0-gpu-jupyter -f Dockerfile .
+    - docker push gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/test-sionna-tensorflow:2.11.0-gpu-jupyter
+  tags:
+    - dind
+  rules:
+    - changes:
+        - .gitlab/docker/test-sionna/tf-2.11.0/*
+  when: manual
+
+documentation:
+  image: gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/python-doc:latest
+  stage: build
+  before_script:
+  - echo 'Cleanup environment...'
+  - git branch -D $CI_DOCUMENTATION_BRANCH || IGNORE_FAILURE=true
+  - git remote remove origin-rw || IGNORE_FAILURE=true
+  - git config --local --replace-all user.name "${CI_GIT_USER_NAME}" || IGNORE_FAILURE=true
+  - git config --local --replace-all user.email "${CI_GIT_USER_EMAIL}" || IGNORE_FAILURE=true
+  script:
+  - echo 'Building documentation...'
+  - make doc
+  - echo 'Fetch current state of documentation branch...'
+  - REPO_URL=`echo $CI_REPOSITORY_URL | cut -d'@' -f 2`
+  - git remote add origin-rw https://$CI_GIT_RW_NAME:$CI_GIT_RW_TOKEN@$REPO_URL 
+  - git remote -v
+  - git fetch origin-rw $CI_DOCUMENTATION_BRANCH
+  - git checkout -b $CI_DOCUMENTATION_BRANCH --track origin-rw/${CI_DOCUMENTATION_BRANCH}
+  - echo 'Replace website folders with updated version...'
+  - rm -rf docs
+  - mv doc/build/html docs
+  - echo 'Commit changes to git'
+  - git add docs
+  - git status
+  - |
+    if git diff --cached --quiet
+    then
+      echo 'No changes detected.'
+    else
+      git commit -m "update Documentation from commit ${CI_COMMIT_SHORT_SHA}"
+      git log -n 1
+      git push origin-rw $CI_DOCUMENTATION_BRANCH
+    fi
+  - echo 'Done.'
+  tags:
+  artifacts:
+    name: "$CI_PROJECT_NAME-docs-$CI_COMMIT_SHORT_SHA"
+    paths:
+    - docs
+  rules:
+    - if: $CI_COMMIT_BRANCH == "main"
+      when: always
+
+all-tests-tf-2.8:
+  image: gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/test-sionna-tensorflow:2.8.4-gpu-jupyter
+  stage: test
+  script:
+  - nvidia-smi
+  - cd test
+  - pytest --junitxml=report-tf-2.8.4.xml
+  tags: 
+  - test
+  artifacts:
+    when: always
+    reports:
+      junit: test/report-tf-2.8.4.xml
+  when: manual
+
+all-tests-tf-2.9:
+  image: gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/test-sionna-tensorflow:2.9.3-gpu-jupyter
+  stage: test
+  script:
+  - nvidia-smi
+  - cd test
+  - pytest --junitxml=report-tf-2.9.3.xml
+  tags: 
+  - test
+  artifacts:
+    when: always
+    reports:
+      junit: test/report-tf-2.9.3.xml
+  when: manual
+
+all-tests-tf-2.10:
+  image: gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/test-sionna-tensorflow:2.10.1-gpu-jupyter
+  stage: test
+  script:
+  - nvidia-smi
+  - cd test
+  - pytest --junitxml=report-tf-2.10.1.xml
+  tags: 
+  - test
+  artifacts:
+    when: always
+    reports:
+      junit: test/report-tf-2.10.1.xml
+#  when: manual
+  rules:
+    - if: $CI_COMMIT_BRANCH == "main"
+      when: always
+
+all-tests-tf-2.11.0:
+  image: gitlab-master.nvidia.com:5005/nvresearch-gcml/sionna/test-sionna-tensorflow:2.11.0-gpu-jupyter
+  stage: test
+  script:
+  - nvidia-smi
+  - cd test
+  - pytest --junitxml=report-tf-2.11.0.xml
+  tags: 
+  - test
+  artifacts:
+    when: always
+    reports:
+      junit: test/report-tf-2.11.0.xml
+  when: manual
+

DOCKERFILE

@@ -1,8 +1,11 @@
-FROM tensorflow/tensorflow:2.10.0-gpu-jupyter
+FROM tensorflow/tensorflow:2.11.0-gpu-jupyter
 EXPOSE 8888
 COPY . /tmp/
 WORKDIR /tmp/
 RUN make install
+RUN apt-get install llvm -y
+RUN pip install --upgrade jupyter
+RUN pip install --upgrade ipykernel
 RUN rm -R /tf/* && cp /tmp/examples/* /tf
 RUN rm -R /tmp
 RUN chmod 777 -R /tf

MANIFEST.in

@@ -1,4 +1,4 @@
-recursive-include ./sionna *.csv *.npy *.json
+recursive-include ./sionna *.csv *.npy *.json *.xml *.ply
 #include ./sionna *.csv, *.npy
 prune test
 

Makefile

@@ -17,7 +17,7 @@ lint:
 	pylint sionna/
 
 run-docker:
-	docker run -u $(id -u):$(id -g) -p 8888:8888 --privileged=true $(GPU) --rm -it sionna
+	docker run -u $(id -u):$(id -g) -p 8888:8888 --privileged=true $(GPU) --env NVIDIA_DRIVER_CAPABILITIES=graphics,compute,utility --rm -it sionna
 
 test: FORCE
 	cd test && pytest

README.md

@@ -15,6 +15,7 @@ You can alternatively test them on [Google Colab](https://colab.research.google.
 Although not necessary, we recommend running Sionna in a [Docker container](https://www.docker.com).
 
 Sionna requires [TensorFlow 2.8-2.11](https://www.tensorflow.org/install) and Python 3.6-3.9. We recommend Ubuntu 20.04. Earlier versions of TensorFlow (2.7+) still work but are not recommended because of known, unpatched CVEs.
+To run the ray tracer on CPU, [LLVM](https://llvm.org) is required.
 
 We refer to the [TensorFlow GPU support tutorial](https://www.tensorflow.org/install/gpu) for GPU support and the required driver setup.
 
@@ -35,7 +36,7 @@ On macOS, you need to install [tensorflow-macos](https://github.com/apple/tensor
 ```
     >>> import sionna
     >>> print(sionna.__version__)
-    0.13.0
+    0.14.0
 ```
 
 3.) Once Sionna is installed, you can run the [Sionna "Hello, World!" example](https://nvlabs.github.io/sionna/examples/Hello_World.html), have a look at the [quick start guide](https://nvlabs.github.io/sionna/quickstart.html), or at the [tutorials](https://nvlabs.github.io/sionna/tutorials.html).
@@ -94,7 +95,7 @@ We recommend to do this within a [virtual environment](https://docs.python.org/3
 ```
     >>> import sionna
     >>> print(sionna.__version__)
-    0.13.0
+    0.14.0
 ```
 
 ## License and Citation

doc/source/_static/css/sionna.css

@@ -37,3 +37,32 @@ html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list) > dt, html.
 h3 {
     display: None;
 }
+
+div.math {
+    position: relative;
+    padding-right: 2.5em;
+}
+.eqno {
+    height: 100%;
+    position: absolute;
+    right: 0;
+    padding-left: 5px;
+    padding-bottom: 5px;
+    /* Fix for mouse over in Firefox */
+    padding-right: 1px;
+}
+.eqno:before {
+    /* Force vertical alignment of number */
+    display: inline-block;
+    height: 100%;
+    vertical-align: middle;
+    content: "";
+}
+
+/* Make responsive */
+.MathJax_Display {
+    max-width: 100%;
+    overflow-x: auto;
+    overflow-y: hidden;
+}
+