HermesPy API¶

This section describes all parts of the HermesPy Application Programming Interface. HermesPy consist of the a self-titled namespace featuring multiple sub-modules, each tackling a different aspect of signal processing for wireless systems. The subpackages may have interdependencies, but in general, the root of dependencies is provided by the core package:

        flowchart TD
   sim[Simulation];
   loop[Hardware Loop];
   beam[Beamforming];
   channel[Channel];
   core[Core];
   fec[FEC];
   jcas[JCAS];
   tools[Tools];
   modem[Modem];
   radar[Radar];
   tools[Tools];

   sim --> core;
   loop --> core;
   beam --> core;
   sim --> channel;
   modem --> fec;
   modem --> core;
   jcas --> modem;
   jcas --> radar;
   radar --> core;
   radar --> beam;

   click beam href "/api/beamforming/index.html";
   click channel href "/api/channel/index.html";
   click core href "/api/core/index.html";
   click fec href "/api/fec/index.html";
   click loop href "/api/hardware_loop/index.html";
   click jcas href "/api/jcas/index.html";
   click modem href "/api/modem/index.html";
   click radar href "/api/radar/index.html";
   click sim href "/api/simulation/index.html";
   click tools href "/api/tools/index.html";

Module	Description
Simulation	Simluation of wireless scenarios, numerical models of the physical layer.
Channel Modeling	Collection of variious wireless channel models.
Hardware Loop	Interfaces to software-defined radio hardware, compatible with the core architecture.
Communication	Signal processing pipelines for communication applications as commonly found in wireless modems.
Sensing	Signal processing pipelines for sensing applications as commonly found in radar systems.
Error Correction	Forward error correction coding and decoding algorithms. Dependency of the modem module.
JCAS	Joint communication and sensing algorithms, including waveform design and resource allocation.
Beamforming	Beamforming algorithms, both digital and analog.
Core	Core architecture, including serialization, device description and Monte Carlo distribution management.