Minor fixes and improvements

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

.github/ISSUE_TEMPLATE/10-bug_report.md

@@ -17,6 +17,8 @@ Steps to reproduce the behavior:
 3. Scroll down to '....'
 4. See error
 
+Alternatively, provide a minimum working example that reproduces the bug (e.g., as Jupyter notebook).
+
 **Expected behavior**
 A clear and concise description of what you expected to happen.
 
@@ -27,11 +29,13 @@ If applicable, add screenshots to help explain your problem.
  - OS: [e.g. Ubuntu 20.04]
  - NVIDIA Driver version: [e.g. 450.00]
  - CUDA version: [e.g. 11.0]
+ - Python version: [e.g. 3.9.5]
  - TensorFlow version: [e.g. 2.5.0]
 
+
 **GPUs:**
  - Model: [e.g. RTX 3090]
- - Memory: [e.g. 24GB] 
+ - Memory: [e.g. 24GB]
 
 **Additional context**
 Add any other context about the problem here.

.github/pull_request_template.md

@@ -0,0 +1,33 @@
+
+## Description
+
+A clear and concise description of what this pull request does.
+
+- Fixes a bug?
+
+Describe what was wrong, and explain the solution in detail.
+
+- Adds a new feature?
+
+Describe the new feature, ensure that it is properly documented. Note that for new features unit tests are required.
+
+- Introduces API changes?
+
+Address in detail why it is needed. Explain and describe the consequences, does it break older code? Note that API changes might be delayed until a major bump release for inclusion.
+
+- Other contributions
+
+Please detail the nature of the submission.
+
+
+## Checklist
+
+[ ] Detailed description
+[ ] Added references to issues and discussions
+[ ] Added / modified documentation as needed
+[ ] Added / modified unit tests as needed
+[ ] Passes all tests
+[ ] Lint the code
+[ ] Performed a self review
+[ ] Ensure you Signed-off the commits. Required to accept contributions!
+[ ] Co-authored with someone? Add Co-authored-by: user@domain and ensure they signed off their commits too.

SECURITY.md

@@ -0,0 +1,14 @@
+# Reporting vulnerabilities
+
+Please email reports about any security related issues you find to `[email protected]`.
+
+Please use a descriptive subject line for your report email. After the initial reply to your report, the team will endeavor to keep you informed of the progress being made towards a fix and announcement.
+
+In addition, please include the following information along with your report:
+
+-   Your name and affiliation (if any).
+-   A description of the technical details of the vulnerabilities. It is very important to let us know how we can reproduce your findings.
+-   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.
+-   Whether this vulnerability public or known to third parties. If it is, please provide details.
+
+If you believe that an existing (public) issue is security-related, please send an email to `[email protected]`. The email should include the issue ID and a short description of why it should be handled according as a security issue.

doc/source/conf.py

@@ -43,7 +43,7 @@
     "sphinx.ext.mathjax",
     "sphinx_rtd_theme",
     "sphinx.ext.viewcode",
-    'sphinx_copybutton'
+    "sphinx_copybutton",
     ]
 
 # Add any paths that contain templates here, relative to this directory.

doc/source/index.rst

@@ -11,6 +11,15 @@ If no GPU is available, Sionna will run on the CPU.
 
 Sionna is developed, continuously extended, and used by NVIDIA to drive 5G and 6G research. It supports MU-MIMO (multi-user multiple input multiple output) link-level simulation setups with 5G-compliant codes including low-density parity check (LDPC) and Polar en-/decoders, the 3GPP channel models, OFDM (orthogonal frequency-division multiplexing), channel estimation, equalization, and soft-demapping. Every building block is an independent module that can be easily tested, understood, and modified according to your needs. The documentation is complete and includes references.
 
+Here is a short video showing Sionna in action:
+
+.. raw:: html
+
+   <center>
+   <iframe width="560" height="315" src="https://www.youtube.com/embed/cYUNE4i4Q4E" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+   </center>
+|
+
 The Benefits of using Sionna
 ###################################
 Most researchers in communications need a tool for link-level simulation to