Merge branch '2024-fall-release' into 'master'

Barkhausen-Institut · Dec 19, 2024 · 9caa557 · 9caa557
2 parents 2a95541 + b134900
commit 9caa557
Show file tree

Hide file tree

Showing 371 changed files with 1,102 additions and 830 deletions.
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -5,7 +5,7 @@ variables:
   PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
   GIT_SUBMODULE_STRATEGY: recursive
   HERMES_WHEEL_12: "hermespy-$HERMES_VERSION-cp312-cp312-linux_x86_64.whl"
-  HERMES_VERSION: "1.3.0"
+  HERMES_VERSION: "1.4.0"
   HERMES_WHEEL_11: "hermespy-$HERMES_VERSION-cp311-cp311-linux_x86_64.whl"
   HERMES_WHEEL_10: "hermespy-$HERMES_VERSION-cp310-cp310-linux_x86_64.whl"
   PYDEVD_DISABLE_FILE_VALIDATION: 1

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -6,6 +6,7 @@ set(CMAKE_CXX_EXTENSIONS OFF)
 
 project(${SKBUILD_PROJECT_NAME} VERSION ${SKBUILD_PROJECT_VERSION} LANGUAGES CXX)
 
+
 # Workaround for building shared libraries on Windows
 if(CMAKE_SYSTEM_NAME STREQUAL "Windows")
     set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS TRUE)
@@ -25,5 +26,8 @@ set(CLI_COMPILE_SHARED_LIB ON CACHE INTERNAL "Disable CLI" FORCE)
 add_subdirectory(submodules/affect)
 add_subdirectory(hermespy/fec/aff3ct)
 
-install(TARGETS aff3ct-shared-lib LIBRARY DESTINATION ${SKBUILD_PROJECT_NAME}/fec/aff3ct/ COMPONENT PythonModule)
+if (WIN32)
+    install(TARGETS aff3ct-shared-lib LIBRARY DESTINATION ${SKBUILD_PROJECT_NAME}/fec/aff3ct/ COMPONENT PythonModule)
+endif()
+
 install(TARGETS ldpc polar rs rsc turbo bch LIBRARY DESTINATION ${SKBUILD_PROJECT_NAME}/fec/aff3ct/ COMPONENT PythonModule)
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ adjacent-channel interference among different communication systems.
 
 ## Features
 
-The current release version 1.3.0 serves as a platform for joint development.
+The current release version 1.4.0 serves as a platform for joint development.
 Its main focus is to provide a software architecture that can be easily extended.
 Detailed core features as well as a release plan can be found in the
 [features](https://hermespy.org/features.html) list.

diff --git a/docssource/api/api.rst b/docssource/api/api.rst
@@ -16,7 +16,7 @@ The subpackages may have interdependencies, but in general, the root of dependen
    channel/channel
    simulation
    hardware_loop
-   core
+   core/core
    fec
    jcas
    beamforming

diff --git a/docssource/api/channel/cdl/cluster_delay_lines.rst b/docssource/api/channel/cdl/cluster_delay_lines.rst
@@ -38,7 +38,7 @@ Both the NLOS and LOS components
       \right)
    \end{split}
 
-are functions of the two :doc:`Antennas'</api/core.antennas>` polarization :meth:`characteristics<hermespy.core.antennas.Antenna.local_characteristics>`
+are functions of the two :doc:`Antennas'</api/core/antennas>` polarization :meth:`characteristics<hermespy.core.antennas.Antenna.local_characteristics>`
 :math:`\mathbf{F}^{(a)}(\theta, \phi)`
 towards angle-of-arrival :math:`\theta_{\mathrm{ZOA}}, \phi_{\mathrm{AOA}}`
 and angle-of-departure :math:`\theta_{\mathrm{ZOD}}, \phi_{\mathrm{AOD}}`.

diff --git a/docssource/api/channel/fading/fading.MultipathFadingChannel.rst b/docssource/api/channel/fading/fading.MultipathFadingChannel.rst
@@ -19,7 +19,7 @@ directly.
 The following minimal example outlines how to configure the channel model
 within the context of a :class:`Simulation<hermespy.simulation.simulation.Simulation>`:
 
-.. literalinclude:: ../../../scripts/examples/channel_MultipathFadingChannel.py
+.. literalinclude:: ../../../scripts/examples/channel_fading_fading.py
    :language: python
    :linenos:
    :lines: 12-40

diff --git a/docssource/api/channel/sionna-rt.rst b/docssource/api/channel/sionna-rt.rst
@@ -56,8 +56,12 @@ within the context of a :class:`Simulation<hermespy.simulation.simulation.Simula
 .. literalinclude:: ../../scripts/examples/channel_SionnaRT.py
    :language: python
    :linenos:
-   :lines: 11-36
+   :lines: 12-36
 
-.. autoclass::  hermespy.channel.fading.exponential.Exponential
+.. autoclass:: hermespy.channel.sionna_rt_channel.SionnaRTChannel
+
+.. autoclass:: hermespy.channel.sionna_rt_channel.SionnaRTChannelRealization
+
+.. autoclass:: hermespy.channel.sionna_rt_channel.SionnaRTChannelSample
 
 .. footbibliography::
diff --git a/docssource/api/core.antennas.rst b/docssource/api/core.antennas.rst
diff --git a/docssource/api/core.channel_state_information.rst b/docssource/api/core.channel_state_information.rst
diff --git a/docssource/api/core.definitions.rst b/docssource/api/core.definitions.rst
diff --git a/docssource/api/core.device.Device.rst b/docssource/api/core.device.Device.rst
diff --git a/docssource/api/core.drop.Drop.rst b/docssource/api/core.drop.Drop.rst
diff --git a/docssource/api/core.executable.rst b/docssource/api/core.executable.rst
diff --git a/docssource/api/core.factory.rst b/docssource/api/core.factory.rst
diff --git a/docssource/api/core.logarithmic.rst b/docssource/api/core.logarithmic.rst
diff --git a/docssource/api/core.operators.rst b/docssource/api/core.operators.rst
diff --git a/docssource/api/core.pipeline.rst b/docssource/api/core.pipeline.rst
diff --git a/docssource/api/core.random_node.rst b/docssource/api/core.random_node.rst
diff --git a/docssource/api/core.rst b/docssource/api/core.rst
diff --git a/docssource/api/core.scenario.rst b/docssource/api/core.scenario.rst
diff --git a/docssource/api/core.signal_model.Signal.rst b/docssource/api/core.signal_model.Signal.rst
diff --git a/docssource/api/core.transformation.rst b/docssource/api/core.transformation.rst
diff --git a/docssource/api/core.visualize.rst b/docssource/api/core.visualize.rst
diff --git a/docssource/api/core/antennas.rst b/docssource/api/core/antennas.rst
@@ -0,0 +1,44 @@
+=====================
+Antenna Descriptions
+=====================
+
+.. inheritance-diagram:: hermespy.core.antennas.Antenna hermespy.core.antennas.IdealAntenna hermespy.core.antennas.PatchAntenna hermespy.core.antennas.Dipole
+   :parts: 1
+   :top-classes: hermespy.core.transformation.Transformable, hermespy.core.factory.Serializable
+
+.. inheritance-diagram:: hermespy.core.antennas.AntennaArrayBase hermespy.core.antennas.AntennaArrayState hermespy.core.antennas.AntennaArray hermespy.core.antennas.UniformArray hermespy.core.antennas.CustomAntennaArray hermespy.core.antennas.AntennaPort
+   :parts: 1
+   :top-classes: collections.abc.Sequence, hermespy.core.transformation.Transformable
+
+
+.. autoclass:: hermespy.core.antennas.Antenna
+
+.. autoclass:: hermespy.core.antennas.IdealAntenna
+
+.. autoclass:: hermespy.core.antennas.LinearAntenna
+
+.. autoclass:: hermespy.core.antennas.PatchAntenna
+
+.. autoclass:: hermespy.core.antennas.Dipole
+
+.. autoclass:: hermespy.core.antennas.AntennaArrayBase
+
+.. autoclass:: hermespy.core.antennas.AntennaArrayState
+
+.. autoclass:: hermespy.core.antennas.AntennaArray
+
+.. autoclass:: hermespy.core.antennas.UniformArray
+
+.. autoclass:: hermespy.core.antennas.CustomAntennaArray
+
+.. autoclass:: hermespy.core.antennas.AntennaPort
+
+.. autoclass:: hermespy.core.antennas.AntennaMode
+
+.. autoclass:: hermespy.core.antennas.AT
+
+.. autoclass:: hermespy.core.antennas.AAT
+
+.. autoclass:: hermespy.core.antennas.APT
+
+.. footbibliography::
diff --git a/docssource/api/core/channel.rst b/docssource/api/core/channel.rst
@@ -0,0 +1,16 @@
+=========================
+Channel State Information
+=========================
+
+.. inheritance-diagram:: hermespy.core.channel.ChannelStateInformation
+   :parts: 1
+
+Channel state information is HermesPy's representation of the information describing a wireless propagation channel between two devices and their respective antenna arrays.
+
+.. autoclass:: hermespy.core.channel.ChannelStateInformation
+
+.. autoclass:: hermespy.core.channel.ChannelStateFormat
+
+.. autoclass:: hermespy.core.channel.ChannelStateDimension
+
+.. footbibliography::
diff --git a/docssource/api/core/core.rst b/docssource/api/core/core.rst
@@ -0,0 +1,30 @@
+====
+Core
+====
+
+The core module of HermesPy provides all basic functionalities of the simulator.
+
+It is split into several interdependent sub-modules:
+
+.. toctree::
+   :maxdepth: 1
+
+   device
+   scenario
+   monte_carlo
+   signal
+   antennas
+   channel
+   drop
+   factory
+   hooks
+   operators
+   precoding
+   random_node
+   state
+   transformation
+   visualize
+   executable
+   pipeline
+   logarithmic
+   definitions
diff --git a/docssource/api/core/definitions.rst b/docssource/api/core/definitions.rst
@@ -0,0 +1,11 @@
+===================
+General Definitions
+===================
+
+.. inheritance-diagram:: hermespy.core.definitions.ConsoleMode
+
+This file contains several definitions that are used throughout the HermesPy API.
+
+.. autoclass:: hermespy.core.definitions.ConsoleMode
+
+.. footbibliography::
diff --git a/docssource/api/core.device.DeviceInput.rst → docssource/api/core/device.DeviceInput.rst b/docssource/api/core.device.DeviceInput.rst → docssource/api/core/device.DeviceInput.rst
diff --git a/docssource/api/core.device.DeviceOutput.rst → docssource/api/core/device.DeviceOutput.rst b/docssource/api/core.device.DeviceOutput.rst → docssource/api/core/device.DeviceOutput.rst
diff --git a/...ource/api/core.device.DeviceReception.rst → ...ource/api/core/device.DeviceReception.rst b/...ource/api/core.device.DeviceReception.rst → ...ource/api/core/device.DeviceReception.rst
diff --git a/...ce/api/core.device.DeviceTransmission.rst → ...ce/api/core/device.DeviceTransmission.rst b/...ce/api/core.device.DeviceTransmission.rst → ...ce/api/core/device.DeviceTransmission.rst
diff --git a/...ource/api/core.device.OperationResult.rst → ...ource/api/core/device.OperationResult.rst b/...ource/api/core.device.OperationResult.rst → ...ource/api/core/device.OperationResult.rst
diff --git a/.../api/core.device.ProcessedDeviceInput.rst → .../api/core/device.ProcessedDeviceInput.rst b/.../api/core.device.ProcessedDeviceInput.rst → .../api/core/device.ProcessedDeviceInput.rst
diff --git a/docssource/api/core.device.Receiver.rst → docssource/api/core/device.Receiver.rst b/docssource/api/core.device.Receiver.rst → docssource/api/core/device.Receiver.rst
diff --git a/docssource/api/core.device.Reception.rst → docssource/api/core/device.Reception.rst b/docssource/api/core.device.Reception.rst → docssource/api/core/device.Reception.rst
diff --git a/docssource/api/core.device.Transmission.rst → docssource/api/core/device.Transmission.rst b/docssource/api/core.device.Transmission.rst → docssource/api/core/device.Transmission.rst
diff --git a/docssource/api/core.device.Transmitter.rst → docssource/api/core/device.Transmitter.rst b/docssource/api/core.device.Transmitter.rst → docssource/api/core/device.Transmitter.rst
diff --git a/docssource/api/core/device.rst b/docssource/api/core/device.rst
@@ -0,0 +1,16 @@
+============
+Device Model
+============
+
+.. inheritance-diagram:: hermespy.core.device.Device
+   :parts: 1
+
+.. autoclass:: hermespy.core.device.Device
+
+.. toctree::
+   :hidden:
+   :glob:
+
+   device.*
+
+.. footbibliography::
diff --git a/docssource/api/core/drop.rst b/docssource/api/core/drop.rst
@@ -0,0 +1,17 @@
+=====
+Drop
+=====
+
+.. inheritance-diagram:: hermespy.core.drop.Drop hermespy.core.drop.EvaluatedDrop
+   :parts: 1
+
+Drops are the main data structure in HermesPy that represent the results of a full simulation scenario run.
+It contains all signal models at different states of the signal processing as well as the information generated by the final digtial processing layers.
+
+.. autoclass:: hermespy.core.drop.Drop
+
+.. autoclass:: hermespy.core.drop.EvaluatedDrop
+
+.. autoclass:: hermespy.core.drop.DropType
+
+.. footbibliography::
diff --git a/docssource/api/core/executable.rst b/docssource/api/core/executable.rst
@@ -0,0 +1,12 @@
+===========
+Executable
+===========
+
+.. inheritance-diagram:: hermespy.core.executable.Executable
+   :parts: 1
+
+Base class of all executable entry points in HermesPy.
+
+.. autoclass:: hermespy.core.executable.Executable
+
+.. footbibliography::