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

Leakage Estimation Optimization & DSP Layer Port Selection See merge request barkhauseninstitut/wicon/hermespy!174
Barkhausen-Institut · Apr 3, 2024 · 0a7c9e0 · 0a7c9e0
2 parents 0b0e948 + de7f2ae
commit 0a7c9e0
Show file tree

Hide file tree

Showing 135 changed files with 1,499 additions and 579 deletions.
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -4,7 +4,7 @@ image: python:3.11
 variables:
   PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
   GIT_SUBMODULE_STRATEGY: recursive
-  HERMES_VERSION: "1.2.0"
+  HERMES_VERSION: "1.1.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"
   HERMES_WHEEL_09: "hermespy-$HERMES_VERSION-cp39-cp39-linux_x86_64.whl"

diff --git a/CMakeLists.txt b/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)
diff --git a/scripts/release/SOURCE_MANIFEST.in → MANIFEST.in b/scripts/release/SOURCE_MANIFEST.in → MANIFEST.in
diff --git a/README.md b/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
diff --git a/_examples/library/getting_started_loop.py b/_examples/library/getting_started_loop.py
@@ -21,8 +21,8 @@
 
 # Configure the waveform to be transmitted over the link
 link.waveform = RootRaisedCosineWaveform(symbol_rate=1e6, oversampling_factor=8,
-                                         num_preamble_symbols=10, num_data_symbols=100,
-                                         roll_off=.9)
+                                                   num_preamble_symbols=10, num_data_symbols=100,
+                                                   roll_off=.9)
 link.waveform.channel_estimation = SingleCarrierLeastSquaresChannelEstimation()
 link.waveform.channel_equalization = SingleCarrierZeroForcingChannelEqualization()
 

diff --git a/_examples/library/getting_started_simulation.py b/_examples/library/getting_started_simulation.py
@@ -20,8 +20,8 @@
 
 # Configure the waveform to be transmitted over the link
 link.waveform = RootRaisedCosineWaveform(symbol_rate=1e6, oversampling_factor=8,
-                                         num_preamble_symbols=10, num_data_symbols=100,
-                                         roll_off=.9)
+                                                   num_preamble_symbols=10, num_data_symbols=100,
+                                                   roll_off=.9)
 link.waveform.channel_estimation = SingleCarrierLeastSquaresChannelEstimation()
 link.waveform.channel_equalization = SingleCarrierZeroForcingChannelEqualization()
 

diff --git a/bumpver.toml b/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}"' ]
diff --git a/docssource/api/modem.rst b/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

diff --git a/docssource/conf.py b/docssource/conf.py
@@ -91,24 +91,11 @@
 inheritance_graph_attrs = dict(
     rankdir="TB",
     size='"6.0, 8.0"',
-    fontsize=16,
+    fontsize=14,
     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 = {

diff --git a/docssource/developer_hints.rst b/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>`_

diff --git a/docssource/examples/examples.rst b/docssource/examples/examples.rst
@@ -1,5 +1,4 @@
-======================
-YAML Examples
+Configuration Examples
 ======================
 
 This chapter provides several configuration examples to the HermsPy command line interface.