openntn 2.0.0a1__tar.gz

openntn-2.0.0a1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Arbeitsbereich Nachrichtentechnik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

openntn-2.0.0a1/LICENSE-APACHE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

openntn-2.0.0a1/MANIFEST.in

@@ -0,0 +1,5 @@
+# The sdist carries the test suite with its reference data; the wheel contains only
+# the openntn package (see [tool.setuptools] in pyproject.toml).
+recursive-include openntn/models *.json
+graft tests
+global-exclude __pycache__ *.py[cod]

openntn-2.0.0a1/PKG-INFO

@@ -0,0 +1,190 @@
+Metadata-Version: 2.4
+Name: openntn
+Version: 2.0.0a1
+Summary: An extension of the Sionna framework with 3GPP TR38.811 non-terrestrial-network channel models
+Author: Tim Düe, Louis Lagona
+Maintainer-email: Louis Lagona <lagona@ant.uni-bremen.de>
+License-Expression: MIT AND Apache-2.0
+Project-URL: Homepage, https://github.com/ant-uni-bremen/OpenNTN
+Project-URL: Source, https://github.com/ant-uni-bremen/OpenNTN
+Project-URL: Issues, https://github.com/ant-uni-bremen/OpenNTN/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Telecommunications Industry
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Communications
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: LICENSE-APACHE
+Requires-Dist: sionna<3.0,>=2.0.1
+Requires-Dist: torch>=2.9.1
+Requires-Dist: numpy>=2.2.6
+Requires-Dist: matplotlib>=3.10.8
+Provides-Extra: test
+Requires-Dist: pytest>=9.0; extra == "test"
+Dynamic: license-file
+
+<p align="center"><img alt="OpenNTN" src="https://raw.githubusercontent.com/ant-uni-bremen/OpenNTN/v2.0.0a1/docs/images/openntn-logo.png" width="400"></p>
+
+<p align="center">3GPP TR 38.811 non-terrestrial network channel models for Sionna</p>
+
+<p align="center">
+<a href="https://pypi.org/project/openntn/"><img alt="PyPI version" src="https://img.shields.io/pypi/v/openntn"></a>
+<a href="https://pypi.org/project/openntn/"><img alt="Python versions" src="https://img.shields.io/pypi/pyversions/openntn"></a>
+<img alt="Licence: MIT AND Apache-2.0" src="https://img.shields.io/badge/licence-MIT%20AND%20Apache--2.0-blue">
+<a href="https://doi.org/10.1109/WSA65299.2025.11202820"><img alt="Paper: WSA 2025" src="https://img.shields.io/badge/paper-WSA%202025-blue"></a>
+</p>
+
+## Overview
+
+OpenNTN is an open-source extension of [Sionna](https://nvlabs.github.io/sionna/) that
+implements the non-terrestrial network (NTN) channel models of 3GPP TR 38.811 for
+satellite links. Its channel models follow the interface of Sionna's TR 38.901 models,
+so they can be used in Sionna's link-level and system-level simulations. OpenNTN 2 is
+built on Sionna 2, which uses PyTorch.
+
+## Key features
+
+- **Scenarios:** dense urban (`DenseUrban`), urban (`Urban`) and suburban (`SubUrban`),
+  with the parameter tables of TR 38.811 clause 6.7.2 and the fast-fading process of
+  TR 38.901 clause 7.5.
+- **Bands and links:** S band (1.9 GHz to 4 GHz) and Ka band (19 GHz to 40 GHz), uplink
+  and downlink, elevation angles from 10 to 90 degrees.
+- **Propagation (TR 38.811 clause 6.6):** line-of-sight probability, free-space path
+  loss, shadow fading, clutter loss, atmospheric gas absorption, ionospheric
+  scintillation in the S band and tropospheric scintillation in the Ka band.
+- **Satellite Doppler:** the Doppler shift of the satellite's orbital motion, in
+  addition to the motion of the user terminals; it can be switched off.
+- **Antennas:** Sionna-style antenna elements, panels and arrays with the TR 38.901
+  element pattern, an omnidirectional pattern, a circular-aperture pattern and the
+  co-phased dual-linear-polarization pattern of 3GPP R1-1802551.
+- **Topology:** a generator for one satellite and the user terminals of a single sector
+  at a given elevation angle and satellite height.
+- **Sionna integration:** the models are Sionna channel models. They return path
+  coefficients and delays in Sionna's format and work with Sionna's channel functions
+  and blocks, such as `cir_to_ofdm_channel` and `OFDMChannel`.
+
+## Installation and requirements
+
+OpenNTN 2 requires Python 3.11 or later and Sionna 2.0.1 or later within 2.x
+(`sionna>=2.0.1,<3.0`). Further dependencies (PyTorch, NumPy, matplotlib) are installed
+with it.
+
+1. Install PyTorch for your platform, CPU or CUDA, as described at
+   https://pytorch.org/get-started/locally/.
+2. Install OpenNTN:
+
+   ```sh
+   python -m pip install openntn
+   ```
+
+OpenNTN 2 is a pre-release until 2.0.0, and its interfaces can still change. pip
+installs a pre-release only if no final release of openntn is available; otherwise
+`--pre` is needed (`python -m pip install --pre openntn`). The changes of this version
+are listed in the
+[changelog](https://github.com/ant-uni-bremen/OpenNTN/blob/v2.0.0a1/CHANGELOG.md).
+
+> **Note:** openntn 2.x requires Sionna 2.x. Installing it into an environment with
+> Sionna 1.x upgrades Sionna to 2.x. For Sionna 1.x and Sionna 0.19, use the
+> corresponding versions of OpenNTN from the repository at
+> https://github.com/ant-uni-bremen/OpenNTN.
+
+## Quickstart
+
+```python
+from sionna.phy.channel import cir_to_ofdm_channel, subcarrier_frequencies
+
+from openntn import Antenna, AntennaArray, Urban
+from openntn.utils import gen_single_sector_topology
+
+carrier_frequency = 2.2e9   # S band downlink
+elevation_angle = 50.0      # degrees
+
+# User terminal: one antenna; satellite: 4 x 4 dual-polarized array
+ut_array = Antenna(polarization="single", polarization_type="V",
+                   antenna_pattern="omni", carrier_frequency=carrier_frequency)
+bs_array = AntennaArray(num_rows=4, num_cols=4, polarization="dual",
+                        polarization_type="cross", antenna_pattern="38.901",
+                        carrier_frequency=carrier_frequency)
+
+channel_model = Urban(carrier_frequency=carrier_frequency, ut_array=ut_array,
+                      bs_array=bs_array, direction="downlink",
+                      elevation_angle=elevation_angle)
+
+# 16 examples of a single sector: one satellite at 600 km, 4 user terminals
+topology = gen_single_sector_topology(batch_size=16, num_ut=4, scenario="urb",
+                                      elevation_angle=elevation_angle, bs_height=600e3)
+channel_model.set_topology(*topology)
+
+# One channel realization: path coefficients a and path delays tau
+a, tau = channel_model(num_time_samples=1, sampling_frequency=15e3)
+
+# Frequency response on 72 subcarriers with Sionna's channel functions
+frequencies = subcarrier_frequencies(num_subcarriers=72, subcarrier_spacing=30e3)
+h_freq = cir_to_ofdm_channel(frequencies, a, tau, normalize=True)
+print(h_freq.shape)  # [batch, rx, rx antennas, tx, tx antennas, time steps, subcarriers]
+```
+
+The models run on the device in `sionna.phy.config.device`; set it before the antennas
+and the channel model are created.
+
+## Citation
+
+If you use OpenNTN in your research, please cite:
+
+T. Düe, M. Vakilifard, C. Bockelmann, D. Wübben and A. Dekorsy, "OpenNTN: An
+Open-Source Framework for Non-Terrestrial Network Channel Simulations," 2025 28th
+International Workshop on Smart Antennas (WSA), Erlangen, Germany, 2025,
+https://doi.org/10.1109/WSA65299.2025.11202820
+
+```bibtex
+@inproceedings{OpenNTNPaper,
+  author = {T. D\"{u}e and M. Vakilifard and C. Bockelmann and D. W\"{u}bben and A. Dekorsy},
+  title = {OpenNTN: An Open-Source Framework for Non-Terrestrial Network Channel Simulations},
+  booktitle = {2025 28th International Workshop on Smart Antennas (WSA)},
+  address = {Erlangen, Germany},
+  year = {2025},
+  month = {Sep},
+  pages = {1--7},
+  doi = {10.1109/WSA65299.2025.11202820}
+}
+```
+
+## Licence
+
+OpenNTN is distributed under the licence expression `MIT AND Apache-2.0`:
+
+- Files derived from NVIDIA Sionna are licensed under the Apache License 2.0
+  ([LICENSE-APACHE](https://github.com/ant-uni-bremen/OpenNTN/blob/v2.0.0a1/LICENSE-APACHE)).
+  Their headers keep NVIDIA's copyright notice and, for modified files, state that
+  they were modified at the University of Bremen.
+- All other files are licensed under the MIT License
+  ([LICENSE](https://github.com/ant-uni-bremen/OpenNTN/blob/v2.0.0a1/LICENSE)).
+
+Data files cannot carry a header. `TDL-A30.json`, `TDL-B100.json` and `TDL-C300.json`
+in `openntn/models` are unchanged copies of Sionna's files and therefore under
+Apache-2.0; the other TDL and CDL files hold the NTN-TDL and NTN-CDL parameters of
+TR 38.811 (Tables 6.9.1-1 to 6.9.1-4 and 6.9.2-1 to 6.9.2-4) and are under MIT like all
+other files.
+
+The OpenNTN logo is not covered by these licences.
+
+## Maintainer and contact
+
+Louis Lagona <lagona@ant.uni-bremen.de>
+
+Bug reports and questions: https://github.com/ant-uni-bremen/OpenNTN/issues
+
+## Acknowledgements
+
+OpenNTN was originally written by Tim Düe at the Department of Communications
+Engineering (Arbeitsbereich Nachrichtentechnik) of the University of Bremen,
+https://www.ant.uni-bremen.de/. It builds on NVIDIA Sionna.

openntn-2.0.0a1/README.md

@@ -0,0 +1,156 @@
+<p align="center"><img alt="OpenNTN" src="https://raw.githubusercontent.com/ant-uni-bremen/OpenNTN/v2.0.0a1/docs/images/openntn-logo.png" width="400"></p>
+
+<p align="center">3GPP TR 38.811 non-terrestrial network channel models for Sionna</p>
+
+<p align="center">
+<a href="https://pypi.org/project/openntn/"><img alt="PyPI version" src="https://img.shields.io/pypi/v/openntn"></a>
+<a href="https://pypi.org/project/openntn/"><img alt="Python versions" src="https://img.shields.io/pypi/pyversions/openntn"></a>
+<img alt="Licence: MIT AND Apache-2.0" src="https://img.shields.io/badge/licence-MIT%20AND%20Apache--2.0-blue">
+<a href="https://doi.org/10.1109/WSA65299.2025.11202820"><img alt="Paper: WSA 2025" src="https://img.shields.io/badge/paper-WSA%202025-blue"></a>
+</p>
+
+## Overview
+
+OpenNTN is an open-source extension of [Sionna](https://nvlabs.github.io/sionna/) that
+implements the non-terrestrial network (NTN) channel models of 3GPP TR 38.811 for
+satellite links. Its channel models follow the interface of Sionna's TR 38.901 models,
+so they can be used in Sionna's link-level and system-level simulations. OpenNTN 2 is
+built on Sionna 2, which uses PyTorch.
+
+## Key features
+
+- **Scenarios:** dense urban (`DenseUrban`), urban (`Urban`) and suburban (`SubUrban`),
+  with the parameter tables of TR 38.811 clause 6.7.2 and the fast-fading process of
+  TR 38.901 clause 7.5.
+- **Bands and links:** S band (1.9 GHz to 4 GHz) and Ka band (19 GHz to 40 GHz), uplink
+  and downlink, elevation angles from 10 to 90 degrees.
+- **Propagation (TR 38.811 clause 6.6):** line-of-sight probability, free-space path
+  loss, shadow fading, clutter loss, atmospheric gas absorption, ionospheric
+  scintillation in the S band and tropospheric scintillation in the Ka band.
+- **Satellite Doppler:** the Doppler shift of the satellite's orbital motion, in
+  addition to the motion of the user terminals; it can be switched off.
+- **Antennas:** Sionna-style antenna elements, panels and arrays with the TR 38.901
+  element pattern, an omnidirectional pattern, a circular-aperture pattern and the
+  co-phased dual-linear-polarization pattern of 3GPP R1-1802551.
+- **Topology:** a generator for one satellite and the user terminals of a single sector
+  at a given elevation angle and satellite height.
+- **Sionna integration:** the models are Sionna channel models. They return path
+  coefficients and delays in Sionna's format and work with Sionna's channel functions
+  and blocks, such as `cir_to_ofdm_channel` and `OFDMChannel`.
+
+## Installation and requirements
+
+OpenNTN 2 requires Python 3.11 or later and Sionna 2.0.1 or later within 2.x
+(`sionna>=2.0.1,<3.0`). Further dependencies (PyTorch, NumPy, matplotlib) are installed
+with it.
+
+1. Install PyTorch for your platform, CPU or CUDA, as described at
+   https://pytorch.org/get-started/locally/.
+2. Install OpenNTN:
+
+   ```sh
+   python -m pip install openntn
+   ```
+
+OpenNTN 2 is a pre-release until 2.0.0, and its interfaces can still change. pip
+installs a pre-release only if no final release of openntn is available; otherwise
+`--pre` is needed (`python -m pip install --pre openntn`). The changes of this version
+are listed in the
+[changelog](https://github.com/ant-uni-bremen/OpenNTN/blob/v2.0.0a1/CHANGELOG.md).
+
+> **Note:** openntn 2.x requires Sionna 2.x. Installing it into an environment with
+> Sionna 1.x upgrades Sionna to 2.x. For Sionna 1.x and Sionna 0.19, use the
+> corresponding versions of OpenNTN from the repository at
+> https://github.com/ant-uni-bremen/OpenNTN.
+
+## Quickstart
+
+```python
+from sionna.phy.channel import cir_to_ofdm_channel, subcarrier_frequencies
+
+from openntn import Antenna, AntennaArray, Urban
+from openntn.utils import gen_single_sector_topology
+
+carrier_frequency = 2.2e9   # S band downlink
+elevation_angle = 50.0      # degrees
+
+# User terminal: one antenna; satellite: 4 x 4 dual-polarized array
+ut_array = Antenna(polarization="single", polarization_type="V",
+                   antenna_pattern="omni", carrier_frequency=carrier_frequency)
+bs_array = AntennaArray(num_rows=4, num_cols=4, polarization="dual",
+                        polarization_type="cross", antenna_pattern="38.901",
+                        carrier_frequency=carrier_frequency)
+
+channel_model = Urban(carrier_frequency=carrier_frequency, ut_array=ut_array,
+                      bs_array=bs_array, direction="downlink",
+                      elevation_angle=elevation_angle)
+
+# 16 examples of a single sector: one satellite at 600 km, 4 user terminals
+topology = gen_single_sector_topology(batch_size=16, num_ut=4, scenario="urb",
+                                      elevation_angle=elevation_angle, bs_height=600e3)
+channel_model.set_topology(*topology)
+
+# One channel realization: path coefficients a and path delays tau
+a, tau = channel_model(num_time_samples=1, sampling_frequency=15e3)
+
+# Frequency response on 72 subcarriers with Sionna's channel functions
+frequencies = subcarrier_frequencies(num_subcarriers=72, subcarrier_spacing=30e3)
+h_freq = cir_to_ofdm_channel(frequencies, a, tau, normalize=True)
+print(h_freq.shape)  # [batch, rx, rx antennas, tx, tx antennas, time steps, subcarriers]
+```
+
+The models run on the device in `sionna.phy.config.device`; set it before the antennas
+and the channel model are created.
+
+## Citation
+
+If you use OpenNTN in your research, please cite:
+
+T. Düe, M. Vakilifard, C. Bockelmann, D. Wübben and A. Dekorsy, "OpenNTN: An
+Open-Source Framework for Non-Terrestrial Network Channel Simulations," 2025 28th
+International Workshop on Smart Antennas (WSA), Erlangen, Germany, 2025,
+https://doi.org/10.1109/WSA65299.2025.11202820
+
+```bibtex
+@inproceedings{OpenNTNPaper,
+  author = {T. D\"{u}e and M. Vakilifard and C. Bockelmann and D. W\"{u}bben and A. Dekorsy},
+  title = {OpenNTN: An Open-Source Framework for Non-Terrestrial Network Channel Simulations},
+  booktitle = {2025 28th International Workshop on Smart Antennas (WSA)},
+  address = {Erlangen, Germany},
+  year = {2025},
+  month = {Sep},
+  pages = {1--7},
+  doi = {10.1109/WSA65299.2025.11202820}
+}
+```
+
+## Licence
+
+OpenNTN is distributed under the licence expression `MIT AND Apache-2.0`:
+
+- Files derived from NVIDIA Sionna are licensed under the Apache License 2.0
+  ([LICENSE-APACHE](https://github.com/ant-uni-bremen/OpenNTN/blob/v2.0.0a1/LICENSE-APACHE)).
+  Their headers keep NVIDIA's copyright notice and, for modified files, state that
+  they were modified at the University of Bremen.
+- All other files are licensed under the MIT License
+  ([LICENSE](https://github.com/ant-uni-bremen/OpenNTN/blob/v2.0.0a1/LICENSE)).
+
+Data files cannot carry a header. `TDL-A30.json`, `TDL-B100.json` and `TDL-C300.json`
+in `openntn/models` are unchanged copies of Sionna's files and therefore under
+Apache-2.0; the other TDL and CDL files hold the NTN-TDL and NTN-CDL parameters of
+TR 38.811 (Tables 6.9.1-1 to 6.9.1-4 and 6.9.2-1 to 6.9.2-4) and are under MIT like all
+other files.
+
+The OpenNTN logo is not covered by these licences.
+
+## Maintainer and contact
+
+Louis Lagona <lagona@ant.uni-bremen.de>
+
+Bug reports and questions: https://github.com/ant-uni-bremen/OpenNTN/issues
+
+## Acknowledgements
+
+OpenNTN was originally written by Tim Düe at the Department of Communications
+Engineering (Arbeitsbereich Nachrichtentechnik) of the University of Bremen,
+https://www.ant.uni-bremen.de/. It builds on NVIDIA Sionna.

openntn-2.0.0a1/openntn/__init__.py

@@ -0,0 +1,37 @@
+#
+# SPDX-FileCopyrightText: Copyright (c) 2021-2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Modified by the Dept. of Communications Engineering of the University of Bremen.
+# The code is based on implementations provided by the NVIDIA CORPORATION & AFFILIATES
+# in Sionna.
+#
+"""
+Channel sub-package of the Sionna library implementing 3GPP TR38.811 models.
+"""
+# pylint: disable=line-too-long
+from importlib import metadata as _metadata
+
+try:
+    __version__ = _metadata.version("openntn")
+except _metadata.PackageNotFoundError:
+    # A source tree that is not installed, for example a checkout running the tests
+    __version__ = "0+unknown"
+
+from .antenna import AntennaElement, AntennaPanel, PanelArray, Antenna, AntennaArray
+from .lsp import LSP, LSPGenerator
+from .rays import Rays, RaysGenerator
+from .system_level_scenario import SystemLevelScenario
+from .channel_coefficients import Topology, ChannelCoefficientsGenerator
+from .system_level_channel import SystemLevelChannel
+
+from .dense_urban_scenario import DenseUrbanScenario
+from .dense_urban import DenseUrban
+from .urban_scenario import UrbanScenario
+from .urban import Urban
+from .sub_urban_scenario import SubUrbanScenario
+from .sub_urban import SubUrban
+# TDL and CDL are not yet implemented and only exist here as a template
+from .tdl import TDL
+from .cdl import CDL
+