Release v0.8.0

Signed-off-by: Guillermo Marcus <[email protected]>

.github/ISSUE_TEMPLATE/10-bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us make this project better
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**System:**
+ - OS: [e.g. Ubuntu 20.04]
+ - NVIDIA Driver version: [e.g. 450.00]
+ - CUDA version: [e.g. 11.0]
+ - TensorFlow version: [e.g. 2.5.0]
+
+**GPUs:**
+ - Model: [e.g. RTX 3090]
+ - Memory: [e.g. 24GB] 
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/20-feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/90-blank.md

@@ -0,0 +1,10 @@
+---
+name: Blank
+about: Empty issue that is not one of the categories above
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

.gitignore

@@ -0,0 +1,13 @@
+.vscode/
+build/
+sionna.egg-info/
+__pycache__
+.ipynb_checkpoints
+.pytest_cache
+.DS_Store
+.buildinfo
+.Trash-1000
+.logs
+dev
+_build
+doc/build

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html.
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq.

CONTRIBUTING.md

@@ -0,0 +1,63 @@
+<!--
+SPDX-FileCopyrightText: Copyright (c) 2021-2022 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+SPDX-License-Identifier: Apache-2.0
+-->
+# Contributing to Sionna
+
+## Issue tracking
+For enhancement, bugfix, or change requests, please open an issue.
+
+## Pull requests
+Creating a pull request requires the following steps:
+
+1. Fork the repository and create your branch from `stable`.
+2. Add new tests if needed in the ``test`` folder.
+3. Lint your code (``make lint``).
+4. Ensure that all tests pass (``make test``).
+5. Include a license at the topf of new files.
+5. Make sure that all commits are "signed-off" as described below.
+
+### Signing your contributions
+
+* We require that all contributors "sign-off" on their commits with the [Developer Certificate of Origin (DCO)](https://developercertificate.org). This certifies that the contribution is your original work, or that you have rights to submit it under the same license, or a compatible license.
+
+* Any contribution which contains commits that are not signed-off will not be accepted.
+
+* To sign-off on a commit, you simply use the `--signoff` (or `-s`) option when committing your changes:
+  ```bash
+  $ git commit -s -m "New feature."
+  ```
+  This will append the following to your commit message:
+  ```
+  Signed-off-by: Your Name <[email protected]>
+  ```
+
+* The full text of the DCO:
+
+  ```
+    Developer Certificate of Origin
+    Version 1.1
+
+    Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+    1 Letterman Drive
+    Suite D4700
+    San Francisco, CA, 94129
+
+    Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
+  ```
+
+  ```
+    Developer's Certificate of Origin 1.1
+
+    By making a contribution to this project, I certify that:
+
+    (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
+
+    (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
+
+    (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
+
+    (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.
+  ```
+
+

DOCKERFILE

@@ -0,0 +1,10 @@
+FROM tensorflow/tensorflow:2.8.0-gpu-jupyter
+EXPOSE 8888
+COPY . /tmp/
+WORKDIR /tmp/
+RUN make install
+RUN rm -R /tf/* && cp /tmp/examples/* /tf
+RUN rm -R /tmp
+RUN chmod 777 -R /tf
+WORKDIR /tf
+CMD ["jupyter", "notebook", "--port=8888", "--no-browser", "--NotebookApp.token=\"\"", "--ip=0.0.0.0", "--allow-root"]

LICENSE

@@ -0,0 +1,14 @@
+SPDX-FileCopyrightText: Copyright (c) 2021-2022 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+SPDX-License-Identifier: Apache-2.0
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

MANIFEST.in

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

Makefile

@@ -0,0 +1,25 @@
+GPU=
+ifdef gpus
+    GPU=--gpus=$(gpus)
+endif
+export GPU
+
+doc: FORCE
+	cd doc && ./build_docs.sh
+
+docker:
+	docker build -t sionna -f DOCKERFILE .
+
+install: FORCE
+	pip install .
+
+lint:
+	pylint sionna/
+
+run-docker:
+	docker run -u $(id -u):$(id -g) -p 8888:8888 --privileged=true $(GPU) --rm -it sionna
+
+test: FORCE
+	cd test && pytest
+
+FORCE:

README.md

@@ -0,0 +1,113 @@
+<!--
+SPDX-FileCopyrightText: Copyright (c) 2021-2022 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+SPDX-License-Identifier: Apache-2.0
+-->
+# Sionna: An Open-Source Library for Next-Generation Physical Layer Research
+
+Sionna&trade; is an open-source Python library for link-level simulations of digital communication systems built on top of the open-source software library [TensorFlow](https://www.tensorflow.org>) for machine learning.
+
+The official documentation can be found [here](https://nvlabs.github.io/sionna/).
+
+## Installation
+Sionna requires [Python](https://www.python.org/) and [Tensorflow](https://www.tensorflow.org/). 
+In order to run the tutorial notebooks on your machine, you also need [Jupyter](https://jupyter.org/).
+You can alternatively test them on [Google Colab](https://colab.research.google.com/).
+Although not necessary, we recommend running Sionna in a [Docker container](https://www.docker.com). 
+
+Sionna requires [TensorFlow 2.5 or higher](https://www.tensorflow.org/install) and Python 3.6-3.9. We recommend Ubuntu 20.04.
+
+We refer to the [TensorFlow GPU support tutorial](https://www.tensorflow.org/install/gpu) for GPU support and the required driver setup.
+
+### Installation using pip
+
+We recommend to do this within a [virtual environment](https://docs.python.org/3/tutorial/venv.html), e.g., using [conda](https://docs.conda.io).
+
+1.) Install the package
+```
+    pip install sionna
+```
+
+2.) Test the installation in Python
+```
+    python
+```
+```
+    >>> import sionna
+    >>> print(sionna.__version__)
+    0.8.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).
+
+The example notebooks can be opened and executed with [Jupyter](https://jupyter.org/).
+
+For a local installation, the [JupyterLab Desktop](https://github.com/jupyterlab/jupyterlab-desktop) application can be used which also includes the Python installation.
+
+### Docker-based installation
+
+1.) Make sure that you have [Docker](<https://docs.docker.com/engine/install/ubuntu/>) installed on your system. On Ubuntu 20.04, you can run for example
+
+```
+    sudo apt install docker.io
+```
+
+Ensure that your user belongs to the `docker` group (see [Docker post-installation](<https://docs.docker.com/engine/install/linux-postinstall/>))
+
+```
+    sudo usermod -aG docker $USER
+```
+Log out and re-login to load updated group memberships.
+
+For GPU support on Linux, you need to install the [NVIDIA Container Toolkit](https://github.com/NVIDIA/nvidia-docker).
+
+
+2.) Build the Sionna Docker image. From within the Sionna directory, run
+
+```
+    make docker
+```
+
+3.) Run the Docker image with GPU support
+
+```
+    make run-docker gpus=all
+```
+or without GPU:
+```
+    make run-docker
+```
+
+This will immediately launch a Docker image with Sionna installed, running Jupyter on port 8888.
+
+4.) Browse through the example notebooks by connecting to [http://127.0.0.1:8888](http://127.0.0.1:8888) in your browser.
+
+### Installation from source
+
+We recommend to do this within a [virtual environment](https://docs.python.org/3/tutorial/venv.html), e.g., using [conda](https://docs.conda.io).
+
+1.) Clone this repository and execute from within its root folder
+```
+    make install
+```
+2.) Test the installation in Python
+```
+    >>> import sionna
+    >>> print(sionna.__version__)
+    0.8.0
+```
+
+## License and Citation
+
+Sionna is Apache-2.0 licensed, as found in the [LICENSE](https://github.com/nvlabs/sionna/blob/main/LICENSE) file.
+
+If you use this software, please cite it as:
+```bibtex
+@article{sionna,
+    title = {Sionna: An Open-Source Library for Next-Generation Physical Layer Research},
+    author = {Hoydis, Jakob and Cammerer, Sebastian and {Ait Aoudia}, Fayçal and Vem, Avinash and Binder, Nikolaus and Marcus, Guillermo and Keller, Alexander},
+    year = {2022},
+    month = {Mar.},
+    journal = {arXiv preprint},
+    online = {https://github.com/NVlabs/sionna/blob/main/sionna.pdf}
+}
+```