Merge branch 'jcas-demo-2024' into 'master'

Optimized Leakage Estimation & DSP Level Port Selection

See merge request barkhauseninstitut/wicon/hermespy!177

CMakeLists.txt

@@ -24,4 +24,4 @@ add_subdirectory(submodules/affect)
 
 # Add aff3ct bindings to hermes api
 add_subdirectory(hermespy/fec/aff3ct)
-install(TARGETS ldpc polar rs rsc turbo bch DESTINATION hermespy/fec/aff3ct)
+install(TARGETS ldpc polar rs rsc turbo bch DESTINATION hermespy/fec/aff3ct)

README.md

@@ -6,10 +6,18 @@ multiple transmit and receive modems, which may operate at different carrier fre
 In addition to simulating individual transmission links, HermesPy allows the analysis of both co-channel and
 adjacent-channel interference among different communication systems.
 
+## Features
+
+The current release version 1.1.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.
+
 ## Documentation
 
 For detailed [installation instructions](https://hermespy.org/installation.html),
-tutorials and a full [API documentation](https://hermespy.org/api/api.html), please consult the official [documentation](https://hermespy.org/index.html) website.
+tutorials and a full API documentation, please consult the official
+[documentation](https://hermespy.org/index.html) website.
 
 ## Contributors
 
@@ -20,4 +28,4 @@ tutorials and a full [API documentation](https://hermespy.org/api/api.html), ple
 * [Egor Achkasov](https://github.com/egor-achkasov)
 
 ## Copyright
-Copyright (C) 2023 Barkhausen Institut gGmbH
+Copyright (C) 2022 Barkhausen Institut gGmbH

bumpver.toml

@@ -1,6 +1,6 @@
 [bumpver]
 
-current_version = "1.2.0"
+current_version = "1.1.0"
 version_pattern = "MAJOR.MINOR.PATCH"
 commit_message = "Bump to version {new_version}"
 commit = false
@@ -16,8 +16,48 @@ push = false
 ".gitlab-ci.yml" = [ 'HERMES_VERSION: "{version}"' ]
 
 # Source files
-"hermespy/*/*.py" = [ '__version__ = "{version}"' ]
+"hermespy/beamforming/*.py" = [ '__version__ = "{version}"' ]
+"hermespy/bin/*.py" = [ '__version__ = "{version}"' ]
+"hermespy/channel/*.py" = [ '__version__ = "{version}"' ]
+"hermespy/core/*.py" = [ '__version__ = "{version}"' ]
+"hermespy/fec/*.py" = [ '__version__ = "{version}"' ]
+"hermespy/hardware_loop/*.py" = [ '__version__ = "{version}"' ]
+"hermespy/hardware_loop/audio/*.py" = [ '__version__ = "{version}"' ]
+"hermespy/hardware_loop/uhd/*.py" = [ '__version__ = "{version}"' ]
+"hermespy/jcas/*.py" = [ '__version__ = "{version}"' ]
+"hermespy/modem/*.py" = [ '__version__ = "{version}"' ]
+"hermespy/modem/precoding/*.py" = [ '__version__ = "{version}"' ]
+"hermespy/modem/tools/*.py" = [ '__version__ = "{version}"' ]
+"hermespy/precoding/*.py" = [ '__version__ = "{version}"' ]
+"hermespy/radar/*.py" = [ '__version__ = "{version}"' ]
+"hermespy/simulation/*.py" = [ '__version__ = "{version}"' ]
+"hermespy/simulation/coupling/*.py" = [ '__version__ = "{version}"' ]
+"hermespy/simulation/isolation/*.py" = [ '__version__ = "{version}"' ]
+"hermespy/simulation/noise/*.py" = [ '__version__ = "{version}"' ]
+"hermespy/simulation/rf_chain/*.py" = [ '__version__ = "{version}"' ]
+"hermespy/tools/*.py" = [ '__version__ = "{version}"' ]
 
 # Test files
-"tests/*/*.py" = [ '__version__ = "{version}"' ]
-"tests/test_install.py" = [ '__version__ = "{version}"' ]
+"tests/integration_tests/*.py" = [ '__version__ = "{version}"' ]
+"tests/integrity_tests/documentation/*.py" = [ '__version__ = "{version}"' ]
+"tests/integrity_tests/examples/*.py" = [ '__version__ = "{version}"' ]
+"tests/unit_tests/bin/*.py" = [ '__version__ = "{version}"' ]
+"tests/unit_tests/beamforming/*.py" = [ '__version__ = "{version}"' ]
+"tests/unit_tests/channel/*.py" = [ '__version__ = "{version}"' ]
+"tests/unit_tests/core/*.py" = [ '__version__ = "{version}"' ]
+"tests/unit_tests/fec/*.py" = [ '__version__ = "{version}"' ]
+"tests/unit_tests/hardware_loop/*.py" = [ '__version__ = "{version}"' ]
+"tests/unit_tests/hardware_loop/audio/*.py" = [ '__version__ = "{version}"' ]
+"tests/unit_tests/hardware_loop/uhd/*.py" = [ '__version__ = "{version}"' ]
+"tests/unit_tests/jcas/*.py" = [ '__version__ = "{version}"' ]
+"tests/unit_tests/modem/*.py" = [ '__version__ = "{version}"' ]
+"tests/unit_tests/modem/precoding/*.py" = [ '__version__ = "{version}"' ]
+"tests/unit_tests/modem/tools/*.py" = [ '__version__ = "{version}"' ]
+"tests/unit_tests/precoding/*.py" = [ '__version__ = "{version}"' ]
+"tests/unit_tests/radar/*.py" = [ '__version__ = "{version}"' ]
+"tests/unit_tests/simulation/*.py" = [ '__version__ = "{version}"' ]
+"tests/unit_tests/simulation/coupling/*.py" = [ '__version__ = "{version}"' ]
+"tests/unit_tests/simulation/isolation/*.py" = [ '__version__ = "{version}"' ]
+"tests/unit_tests/simulation/noise/*.py" = [ '__version__ = "{version}"' ]
+"tests/unit_tests/simulation/rf_chain/*.py" = [ '__version__ = "{version}"' ]
+"tests/unit_tests/tools/*.py" = [ '__version__ = "{version}"' ]

docssource/api/modem.rst

@@ -92,7 +92,7 @@ and associated :doc:`Communication Waveforms<modem.waveform>`:
    DuplexModem --|> TransmittingModem
    DuplexModem --|> ReceivingModem
 
-   link CommunicationWaveform "modem.waveform.html"
+   link CommunicationWaveform "modem.waveform.waveform.html"
    link BaseModem "modem.modem.BaseModem.html"
    link TransmittingModem "modem.modem.TransmittingModem.html"
    link ReceivingModem "modem.modem.ReceivingModem.html"
@@ -121,38 +121,6 @@ of communication systems:
 
 .. include:: modem.evaluators._table.rst
 
-Setting up a simulation evaluating the performance of a communication system
-requires adding modems to devices and configuring the respective waveform:
-
-.. literalinclude:: ../../_examples/library/getting_started_simulation.py
-   :language: python
-   :linenos:
-   :lines: 08-26
-
-Afterwards, evaluators can be added freely and the simulation can be run:
-
-.. literalinclude:: ../../_examples/library/getting_started_simulation.py
-   :language: python
-   :linenos:
-   :lines: 41-49
-
-In the case of hardware evaluations, the waveform and modem configuartions remain the same,
-however, the devices are replaced by hardware devices initialized from a hardware loop:
-
-.. literalinclude:: ../../_examples/library/getting_started_loop.py
-   :language: python
-   :linenos:
-   :lines: 07-27
-
-Then, similarly to the simulation, evaluators can be added and the loop can be run.
-Additionally, visualizers plotting information generated by the communication system
-can be added to supervise the evaluation:
-
-.. literalinclude:: ../../_examples/library/getting_started_loop.py
-   :language: python
-   :linenos:
-   :lines: 29-43
-
 .. toctree::
    :glob:
    :maxdepth: 1

docssource/api/modem.symbols.rst

@@ -1,3 +1,15 @@
-.. automodule:: hermespy.modem.symbols
+=======
+Symbols
+=======
+
+.. inheritance-diagram:: hermespy.modem.symbols.Symbols
+   :parts: 1
+
+Communication symbols represent a stream of complex-valued symbols that are processed
+during coherent communication.
+
+.. autoclass:: hermespy.modem.symbols.Symbols
+
+.. autoclass:: hermespy.modem.symbols._ConstellationPlot
 
 .. footbibliography::

docssource/conf.py

@@ -23,7 +23,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'HermesPy'
-copyright = '2023, Barkhausen Institut gGmbH'
+copyright = '2024, Barkhausen Institut gGmbH'
 author = 'Barkhausen Institut gGmbH'
 
 # -- General configuration ---------------------------------------------------
@@ -94,21 +94,10 @@
     fontsize=16,
     ratio='compress',
     fontweight='bold',
-    fontcolor='white',
     fontname='"Helvetica Neue, Helvetica, Arial, sans-serif"',
-    bgcolor='transparent',
 )
 inheritance_node_attrs = dict(
-    color='"#263238"',
-    fillcolor='"#37474F"',
-    fontcolor='white',
 )
-inheritance_edge_attrs = dict(
-    color='"#263238"',
-    fillcolor='"#37474F"',
-)
-
-graphviz_output_format = 'svg'
 
 # Intersphinx configuration
 intersphinx_mapping = {

docssource/developer_hints.rst

@@ -86,8 +86,6 @@ It requires some additional dependencies which may be installed from PyPi via
 
    pip install -e ".[documentation]"
 
-Additionally, inheritance diagrams are generated by `Graphviz <https://graphviz.org/>`_,
-which has to be installed manually on your system and added to the PATH environment variable.
 The documentation source files are located under `/docssource/`, however,
 most API information should be directly inserted into the source code files and inserted
 by the `autodocs <https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html>`_

docssource/examples/examples.rst

@@ -1,5 +1,4 @@
-======================
-YAML Examples
+Configuration Examples
 ======================
 
 This chapter provides several configuration examples to the HermsPy command line interface.

docssource/index.rst

@@ -49,6 +49,7 @@ or directly contact the current `maintainer`_.
 
 .. footbibliography::
 
+
 .. _GitHub: https://github.com/Barkhausen-Institut/hermespy
 .. _GitHub pull requests: https://github.com/Barkhausen-Institut/hermespy/pulls
 .. _GitHub issue: https://github.com/Barkhausen-Institut/hermespy/issues

docssource/scripts/radar_simulation.py

@@ -4,7 +4,7 @@
 __copyright__ = "Copyright 2023, Barkhausen Institut gGmbH"
 __credits__ = ["Jan Adler"]
 __license__ = "AGPLv3"
-__version__ = "1.1.0"
+__version__ = "1.2.0"
 __maintainer__ = "Jan Adler"
 __email__ = "jan.adler@barkhauseninstitut.org"
 __status__ = "Prototype"

docssource/static/tweaks.css

@@ -24,10 +24,4 @@ span.brackets > a:after {
 img.inheritance {
     margin: 0 auto;
     display: block;
-}
-
-.inheritance.graphviz {
-    margin-left: auto;
-    margin-right: auto;
-    display: block;
 }

hermespy/channel/delay.py

@@ -315,7 +315,8 @@ def model_propagation_loss(self, value: bool) -> None:
         self.__model_propagation_loss = value
 
     @abstractmethod
-    def _init_realization(self, *args, **kwargs) -> DCRT: ...  # pragma: no cover
+    def _init_realization(self, *args, **kwargs) -> DCRT:
+        ...  # pragma: no cover
 
     def _realize(self) -> DCRT:
         delay = self._realize_delay()

hermespy/channel/radar_channel.py

@@ -912,7 +912,9 @@ def propagation_response(
 
             wavelength = speed_of_light / carrier_frequency
             amplitude_factor = (
-                wavelength * self.cross_section**0.5 / ((4 * pi) ** 1.5 * tx_distance * rx_distance)
+                wavelength
+                * self.cross_section**0.5
+                / ((4 * pi) ** 1.5 * tx_distance * rx_distance)
             )
 
         else:

hermespy/core/device.py

@@ -1245,10 +1245,12 @@ def min_num_samples_per_frame(self) -> int:
         return ceil(frame_duration * sampling_rate)
 
     @overload
-    def __getitem__(self, item: int) -> OperatorType: ...  # pragma:  no cover
+    def __getitem__(self, item: int) -> OperatorType:
+        ...  # pragma:  no cover
 
     @overload
-    def __getitem__(self, item: slice) -> Sequence[OperatorType]: ...  # pragma: no cover
+    def __getitem__(self, item: slice) -> Sequence[OperatorType]:
+        ...  # pragma: no cover
 
     def __getitem__(self, item: int | slice) -> OperatorType | Sequence[OperatorType]:
         return self.__operators[item]

hermespy/core/duplex.py

@@ -83,24 +83,31 @@ def slot(self, value: OperatorSlot[Transmitter]) -> None:
         Transmitter.slot.fset(self, value)
 
     @abstractmethod
-    def _transmit(self, duration: float = 0.0) -> TransmissionType: ...  # pragma: no cover
+    def _transmit(self, duration: float = 0.0) -> TransmissionType:
+        ...  # pragma: no cover
 
     @abstractmethod
-    def _receive(self, signal: Signal) -> ReceptionType: ...  # pragma: no cover
+    def _receive(self, signal: Signal) -> ReceptionType:
+        ...  # pragma: no cover
 
     @property
     @abstractmethod
-    def sampling_rate(self) -> float: ...  # pragma: no cover
+    def sampling_rate(self) -> float:
+        ...  # pragma: no cover
 
     @property
     @abstractmethod
-    def frame_duration(self) -> float: ...  # pragma: no cover
+    def frame_duration(self) -> float:
+        ...  # pragma: no cover
 
     @abstractmethod
-    def _noise_power(self, strength: float, snr_type: SNRType) -> float: ...  # pragma: no cover
+    def _noise_power(self, strength: float, snr_type: SNRType) -> float:
+        ...  # pragma: no cover
 
     @abstractmethod
-    def _recall_transmission(self, group: Group) -> TransmissionType: ...  # pragma: no cover
+    def _recall_transmission(self, group: Group) -> TransmissionType:
+        ...  # pragma: no cover
 
     @abstractmethod
-    def _recall_reception(self, group: Group) -> ReceptionType: ...  # pragma: no cover
+    def _recall_reception(self, group: Group) -> ReceptionType:
+        ...  # pragma: no cover

hermespy/core/logarithmic.py

@@ -393,13 +393,15 @@ def __reduce__(
 @overload
 def dB(
     *values: Sequence[Union[int, float]], conversion: DbConversionType = DbConversionType.POWER
-) -> LogarithmicSequence: ...  # pragma no cover
+) -> LogarithmicSequence:
+    ...  # pragma no cover
 
 
 @overload
 def dB(
     *values: Union[int, float], conversion: DbConversionType = DbConversionType.POWER
-) -> Union[Logarithmic, LogarithmicSequence]: ...  # pragma no cover
+) -> Union[Logarithmic, LogarithmicSequence]:
+    ...  # pragma no cover
 
 
 def dB(

hermespy/core/scenario.py

@@ -687,17 +687,20 @@ def transmit_devices(self) -> Sequence[DeviceTransmission]:
     @overload
     def process_inputs(
         self, impinging_signals: Sequence[DeviceInput], cache: bool = True
-    ) -> Sequence[ProcessedDeviceInput]: ...  # pragma: no cover
+    ) -> Sequence[ProcessedDeviceInput]:
+        ...  # pragma: no cover
 
     @overload
     def process_inputs(
         self, impinging_signals: Sequence[Signal], cache: bool = True
-    ) -> Sequence[ProcessedDeviceInput]: ...  # pragma: no cover
+    ) -> Sequence[ProcessedDeviceInput]:
+        ...  # pragma: no cover
 
     @overload
     def process_inputs(
         self, impinging_signals: Sequence[Sequence[Signal]], cache: bool = True
-    ) -> Sequence[ProcessedDeviceInput]: ...  # pragma: no cover
+    ) -> Sequence[ProcessedDeviceInput]:
+        ...  # pragma: no cover
 
     def process_inputs(
         self,
@@ -735,15 +738,18 @@ def process_inputs(
     @overload
     def receive_operators(
         self, operator_inputs: Sequence[ProcessedDeviceInput], cache: bool = True
-    ) -> Sequence[Sequence[Reception]]: ...  # pragma: no cover
+    ) -> Sequence[Sequence[Reception]]:
+        ...  # pragma: no cover
 
     @overload
     def receive_operators(
         self, operator_inputs: Sequence[Sequence[Signal]], cache: bool = True
-    ) -> Sequence[Sequence[Reception]]: ...  # pragma: no cover
+    ) -> Sequence[Sequence[Reception]]:
+        ...  # pragma: no cover
 
     @overload
-    def receive_operators(self) -> Sequence[Sequence[Reception]]: ...  # pragma: no cover
+    def receive_operators(self) -> Sequence[Sequence[Reception]]:
+        ...  # pragma: no cover
 
     def receive_operators(
         self,
@@ -786,17 +792,20 @@ def receive_operators(
     @overload
     def receive_devices(
         self, impinging_signals: Sequence[DeviceInput], cache: bool = True
-    ) -> Sequence[DeviceReception]: ...  # pragma: no cover
+    ) -> Sequence[DeviceReception]:
+        ...  # pragma: no cover
 
     @overload
     def receive_devices(
         self, impinging_signals: Sequence[Signal], cache: bool = True
-    ) -> Sequence[DeviceReception]: ...  # pragma: no cover
+    ) -> Sequence[DeviceReception]:
+        ...  # pragma: no cover
 
     @overload
     def receive_devices(
         self, impinging_signals: Sequence[Sequence[Signal]], cache: bool = True
-    ) -> Sequence[DeviceReception]: ...  # pragma: no cover
+    ) -> Sequence[DeviceReception]:
+        ...  # pragma: no cover
 
     def receive_devices(
         self,