dapps 0.2.0__tar.gz → 0.2.1__tar.gz

{dapps-0.2.0 → dapps-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dapps
-Version: 0.2.0
+Version: 0.2.1
 Summary: A library for creating and connecting dApps to Open RAN units.
 Keywords: dApps,O-RAN,5G,cellular,networks
 Author-Email: Andrea Lacava <thecave003@gmail.com>
@@ -19,9 +19,9 @@ Requires-Python: >=3.12
 Requires-Dist: asn1tools
 Requires-Dist: typing_extensions
 Requires-Dist: numpy
-Requires-Dist: pyzmq
 Requires-Dist: sigmf
 Requires-Dist: jsonschema>=4.18.0
+Requires-Dist: protobuf>=4.21
 Provides-Extra: api
 Requires-Dist: influxdb_client; extra == "api"
 Provides-Extra: cnn
@@ -31,6 +31,7 @@ Requires-Dist: flask; extra == "gui"
 Requires-Dist: flask-sock; extra == "gui"
 Requires-Dist: flask-cors; extra == "gui"
 Requires-Dist: matplotlib; extra == "gui"
+Requires-Dist: pyzmq; extra == "gui"
 Provides-Extra: network
 Requires-Dist: pysctp; extra == "network"
 Provides-Extra: all
@@ -39,6 +40,7 @@ Requires-Dist: flask; extra == "all"
 Requires-Dist: flask-sock; extra == "all"
 Requires-Dist: flask-cors; extra == "all"
 Requires-Dist: matplotlib; extra == "all"
+Requires-Dist: pyzmq; extra == "all"
 Requires-Dist: influxdb_client; extra == "all"
 Requires-Dist: libiq; extra == "all"
 Description-Content-Type: text/markdown
@@ -49,6 +51,26 @@ A complete tutorial on how to deploy a dApp can be found on the [OpenRAN Gym web
 
 ## Installation
 
+### Prerequisite: libe3 Python bindings (`libe3py`)
+
+All **E3AP** operations (transport, setup handshake, subscribe, indication/control
+framing, and the ASN.1/JSON/Protobuf wire encoding) are handled by
+[**libe3**](https://github.com/wineslab/libe3); this library keeps only the
+**E3SM** (service-model) encode/decode in Python — the same split OAI uses on the
+RAN side. You must therefore install libe3 with its Python bindings **into the
+same interpreter/venv** that runs the dApp, *before* installing this package:
+
+```bash
+cd ~/libe3
+./build_libe3 --install --enable-swig \
+  --cmake-opt "-DLIBE3_ENABLE_ASN1=ON -DLIBE3_ENABLE_JSON=ON"
+python3 -c "import libe3py; print('libe3py OK')"
+```
+
+The dApp's `--link` / `--transport` / `--encoding` must match the gNB's
+`E3Configuration`. See [libe3's `swig/README.md`](https://github.com/wineslab/libe3/blob/main/swig/README.md)
+for the binding architecture.
+
 ### Python package installation (recommended)
 
 ```
@@ -237,7 +259,7 @@ spear-openairinterface5g/openair2/E3AP/service_models/<sm_name>_sm/
 
 For dApp-side (when `--target dapp` or `both`):
 ```
-spear-dApp/src/<sm_name>/
+dApp-library/src/<sm_name>/
 ├── __init__.py
 ├── <sm_name>_dapp.py       # Main dApp implementation
 └── defs/

{dapps-0.2.0 → dapps-0.2.1}/README.md

@@ -4,6 +4,26 @@ A complete tutorial on how to deploy a dApp can be found on the [OpenRAN Gym web
 
 ## Installation
 
+### Prerequisite: libe3 Python bindings (`libe3py`)
+
+All **E3AP** operations (transport, setup handshake, subscribe, indication/control
+framing, and the ASN.1/JSON/Protobuf wire encoding) are handled by
+[**libe3**](https://github.com/wineslab/libe3); this library keeps only the
+**E3SM** (service-model) encode/decode in Python — the same split OAI uses on the
+RAN side. You must therefore install libe3 with its Python bindings **into the
+same interpreter/venv** that runs the dApp, *before* installing this package:
+
+```bash
+cd ~/libe3
+./build_libe3 --install --enable-swig \
+  --cmake-opt "-DLIBE3_ENABLE_ASN1=ON -DLIBE3_ENABLE_JSON=ON"
+python3 -c "import libe3py; print('libe3py OK')"
+```
+
+The dApp's `--link` / `--transport` / `--encoding` must match the gNB's
+`E3Configuration`. See [libe3's `swig/README.md`](https://github.com/wineslab/libe3/blob/main/swig/README.md)
+for the binding architecture.
+
 ### Python package installation (recommended)
 
 ```
@@ -192,7 +212,7 @@ spear-openairinterface5g/openair2/E3AP/service_models/<sm_name>_sm/
 
 For dApp-side (when `--target dapp` or `both`):
 ```
-spear-dApp/src/<sm_name>/
+dApp-library/src/<sm_name>/
 ├── __init__.py
 ├── <sm_name>_dapp.py       # Main dApp implementation
 └── defs/

dapps-0.2.1/VERSION

@@ -0,0 +1 @@
+0.2.1

dapps-0.2.1/examples/__init__.py

@@ -0,0 +1,3 @@
+"""Runnable dApp examples, shipped in the wheel so they can be launched with
+``python -m examples.spectrum_dapp`` / ``python -m examples.simple_dapp`` from an
+installed ``dapps`` package (e.g. the OAI rfsim CI driving the real dApp)."""

{dapps-0.2.0 → dapps-0.2.1}/examples/nvidia_dapp.py

@@ -6,7 +6,7 @@ Example script to showcase the Nvidia dApp
 import argparse
 import time
 
-from e3interface.e3_connector import E3LinkLayer, E3TransportLayer
+from e3interface.e3_transport import E3LinkLayer, E3TransportLayer
 from nvidia.nvidia_dapp import NvidiaDApp
 
 

{dapps-0.2.0 → dapps-0.2.1}/examples/simple_dapp.py

@@ -13,7 +13,7 @@ import argparse
 import threading
 import time
 
-from e3interface.e3_connector import E3LinkLayer, E3TransportLayer
+from e3interface.e3_transport import E3LinkLayer, E3TransportLayer
 from simple.simple_dapp import SimpleDApp
 
 
@@ -101,7 +101,7 @@ if __name__ == "__main__":
         "--encoding",
         type=str,
         default="asn1",
-        choices=["asn1", "json"],
+        choices=["asn1", "json", "protobuf"],
         help="Encoding format (default: asn1)",
     )
     parser.add_argument(

{dapps-0.2.0 → dapps-0.2.1}/examples/spectrum_dapp.py

@@ -8,7 +8,7 @@ import threading
 import time
 import logging
 
-from e3interface.e3_connector import E3LinkLayer, E3TransportLayer
+from e3interface.e3_transport import E3LinkLayer, E3TransportLayer
 from spectrum.spectrum_dapp import (
     SpectrumSharingDApp,
     compute_fft_size,
@@ -251,7 +251,7 @@ if __name__ == "__main__":
                              "1/beta). Default 1/2048 matches the gNB code default; "
                              "the X410 sample conf overrides it to 0.0078125 (1/128).")
     parser.add_argument('--encoding-method', type=str, default='asn1',
-                        choices=['asn1', 'json'],
+                        choices=['asn1', 'json', 'protobuf'],
                         help="Wire encoding for Spectrum-* envelopes (default: asn1).")
     parser.add_argument('--no-sensing-only', dest='sensing_only',
                         action='store_false', default=True,

{dapps-0.2.0 → dapps-0.2.1}/pyproject.toml

@@ -19,13 +19,20 @@ classifiers = [
 ]
 license = "Apache-2.0"
 license-files = ["LICENSE"]
+# NOTE: E3AP transport is provided by libe3's Python bindings (`libe3py`),
+# which are not on PyPI. Install them into this environment with:
+#   cd ~/libe3 && ./build_libe3 --install --enable-swig \
+#     --cmake-opt "-DLIBE3_ENABLE_ASN1=ON -DLIBE3_ENABLE_JSON=ON"
+# (asn1tools is still required for the in-Python service-model codecs.)
 dependencies = [
     "asn1tools",
     "typing_extensions",
     "numpy",
-    "pyzmq",
     "sigmf",
     "jsonschema>=4.18.0",
+    # protobuf E3SM codec path (spectrum/simple SMs); >=4.21 for FieldDescriptor
+    # .has_presence and the current generated-code format.
+    "protobuf>=4.21",
 ]
 
 authors = [
@@ -43,7 +50,7 @@ Source = "https://github.com/wineslab/dApp-library"
 [project.optional-dependencies]
 api = ["influxdb_client"]
 cnn = ["libiq"]
-gui = ["flask", "flask-sock", "flask-cors", "matplotlib"]
+gui = ["flask", "flask-sock", "flask-cors", "matplotlib", "pyzmq"]
 network = ["pysctp"]
 all = [
     "pysctp",
@@ -51,6 +58,7 @@ all = [
     "flask-sock",
     "flask-cors",
     "matplotlib",
+    "pyzmq",
     "influxdb_client",
     "libiq",
 ]
@@ -72,6 +80,10 @@ wheel.packages = [
     "src/simple",
     "src/iq_saver",
     "src/visualization",
+    # Ship the runnable examples so they can be launched from the installed
+    # wheel via `python -m examples.<name>` (e.g. the OAI rfsim CI driving the
+    # real spectrum dApp) instead of a hand-rolled launcher.
+    "examples",
 ]
 
 # Include the libiqsaver C++ tree and the root CMake in the sdist so

{dapps-0.2.0 → dapps-0.2.1}/src/dapp/dapp.py

@@ -10,7 +10,6 @@ from abc import ABC, abstractmethod
 import threading
 import time
 from e3interface.e3_interface import E3Interface
-from e3interface.e3_encoder import AsnE3Encoder, JsonE3Encoder
 from e3interface.e3_logging import dapp_logger
 
 class DApp(ABC):
@@ -30,16 +29,14 @@ class DApp(ABC):
         self.dapp_version = dapp_version
         self.vendor = vendor
         self.e3ap_protocol_version = e3ap_protocol_version
-        self.encoding_method = encoding_method        
-        match self.encoding_method:
-            case "asn1":
-                encoder = AsnE3Encoder()
-            case "json":
-                encoder = JsonE3Encoder()
-            case _:
-                raise ValueError(f"Unsupported encoding method: {self.encoding_method}")
-
-        self.e3_interface = E3Interface(encoder=encoder, link=link, transport=transport)
+        self.encoding_method = encoding_method
+        if encoding_method not in ("asn1", "json", "protobuf"):
+            raise ValueError(f"Unsupported encoding method: {encoding_method}")
+
+        # libe3 owns E3AP (transport + wire encoding); the encoding string is
+        # passed straight through and must match the gNB E3Configuration.
+        self.e3_interface = E3Interface(
+            link=link, transport=transport, encoding=encoding_method)
         self.stop_event = threading.Event()
 
         dapp_logger.info(f'Using {link} and {transport}')