dapps 0.0.1__tar.gz → 0.0.2__tar.gz

dapps-0.0.2/.github/workflows/tag-and-release.yml

@@ -0,0 +1,146 @@
+name: Tag and Publish dApp package
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  create-tag:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.set_version.outputs.version }}
+      tag_created: ${{ steps.set_output.outputs.tag_created }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Ensure we fetch all tags
+
+      - name: Read VERSION file
+        id: get_version
+        run: |
+          version=$(cat VERSION | tr -d '[:space:]')
+          echo "version=$version" >> $GITHUB_OUTPUT
+
+      - name: Check if tag exists
+        id: check_tag
+        run: |
+          if git rev-parse "refs/tags/${{ steps.get_version.outputs.version }}" >/dev/null 2>&1; then
+            echo "exists=true" >> $GITHUB_OUTPUT
+          else
+            echo "exists=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Create and push tag
+        if: steps.check_tag.outputs.exists == 'false'
+        id: create_push_tag
+        run: |
+          git tag ${{ steps.get_version.outputs.version }}
+          git push origin ${{ steps.get_version.outputs.version }}
+
+      - name: Set tag_created output
+        id: set_output
+        run: |
+          if [ "${{ steps.check_tag.outputs.exists }}" = "false" ]; then
+            echo "tag_created=true" >> $GITHUB_OUTPUT
+          else
+            echo "tag_created=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Set version output
+        id: set_version
+        run: |
+          echo "version=${{ steps.get_version.outputs.version }}" >> $GITHUB_OUTPUT
+
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+    needs: create-tag
+    if: ${{ needs.create-tag.outputs.tag_created == 'true' && github.repository == 'wineslab/dApp-library' }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.8"
+      - name: Install pypa/build
+        run: python3 -m pip install build --user
+      - name: Build a binary wheel and a source tarball
+        run: python3 -m build
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-to-pypi:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    if: ${{ needs.create-tag.outputs.tag_created == 'true' && github.repository == 'wineslab/dApp-library' }}
+    environment:
+      name: pypi
+      url: https://pypi.org/p/dapps
+    permissions:
+      id-token: write
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: Sign packages with Sigstore and upload them to GitHub Release
+    needs: publish-to-pypi
+    runs-on: ubuntu-latest
+    if: ${{ needs.create-tag.outputs.tag_created == 'true' && github.repository == 'wineslab/dApp-library' }}
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Sign the dists with Sigstore
+        uses: sigstore/gh-action-sigstore-python@v3.0.0
+        with:
+          inputs: |
+            ./dist/*.tar.gz
+            ./dist/*.whl
+      - name: Create GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        run: gh release create ${{ needs.create-tag.outputs.version }} --repo ${{ github.repository }} --notes ""
+      - name: Upload artifact signatures to GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        run: gh release upload ${{ needs.create-tag.outputs.version }} dist/** --repo ${{ github.repository }}
+
+  publish-to-testpypi:
+    name: Publish to TestPyPI
+    needs: build
+    runs-on: ubuntu-latest
+    if: ${{ needs.create-tag.outputs.tag_created == 'true' && github.repository == 'wineslab/dApp-library' }}
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/dapps
+    permissions:
+      id-token: write
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution 📦 to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/

{dapps-0.0.1 → dapps-0.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dapps
-Version: 0.0.1
+Version: 0.0.2
 Summary: A library for creating and connecting dApps to Open RAN units.
 Project-URL: Homepage, https://openrangym.com/ran-frameworks/dapps
 Project-URL: Package, https://pypi.org/project/dapps/

dapps-0.0.2/VERSION

@@ -0,0 +1 @@
+0.0.2

{dapps-0.0.1 → dapps-0.0.2}/docs/gui_uml.txt

@@ -34,7 +34,7 @@ class IQPlotter {
     + process_iq_data(iq_data)
 }
 
-class DemoGui {
+class Dashboard {
     -- Attributes --
     - BUFFER_SIZE : int
     - iq_size : int
@@ -49,6 +49,4 @@ class DemoGui {
     + stop()
 }
 
-DemoGui --> IQPlotter : "contains"
-DemoGui --> EnergyPlotter : "contains"
 @enduml

{dapps-0.0.1 → dapps-0.0.2}/examples/spectrum_dapp.py

@@ -23,10 +23,18 @@ def stop_program(time_to_wait, dapp: SpectrumSharingDApp):
 def main(args, time_to_wait: float = 60.0):
     # with open(f"{LOG_DIR}/busy.txt", "w") as f:
     #     f.close()
-    
-    dapp = SpectrumSharingDApp(ota=args.ota, save_iqs=args.save_iqs, control=args.control, link=args.link, transport=args.transport,
-                energyGui=args.energy_gui, iqPlotterGui=args.iq_plotter_gui, demoGui=args.demo_gui)
 
+    if args.ota:
+        print(f'Using OTA configuration')
+        noise_floor_threshold = 20 # this really depends on the RF conditions and should be carefully calibrated
+    else: # Colosseum
+        print(f'Using Colosseum configuration')
+        noise_floor_threshold = 53
+
+    print(f'Threshold {noise_floor_threshold}')
+    
+    dapp = SpectrumSharingDApp(noise_floor_threshold=noise_floor_threshold, save_iqs=args.save_iqs, control=args.control, link=args.link, transport=args.transport,
+                energyGui=args.energy_gui, iqPlotterGui=args.iq_plotter_gui, dashboard=args.demo_gui)
     dapp.setup_connection()
     
     if args.timed:

{dapps-0.0.1 → dapps-0.0.2}/src/spectrum/spectrum_dapp.py

@@ -25,7 +25,7 @@ class SpectrumSharingDApp(DApp):
     # Noise floor threshold needs to be calibrated
     # We receive the symbols and average them over some frames, and do thresholding.
 
-    def __init__(self, id: int = 1, ota: bool = False, save_iqs: bool = False, control: bool = False, link: str = 'posix', transport:str = 'uds', **kwargs):
+    def __init__(self, id: int = 1, noise_floor_threshold: int = 53, save_iqs: bool = False, control: bool = False, link: str = 'posix', transport:str = 'uds', **kwargs):
         super().__init__(link=link, transport=transport, **kwargs) 
 
         self.bw = 40.08e6  # Bandwidth in Hz
@@ -35,14 +35,7 @@ class SpectrumSharingDApp(DApp):
         self.prb_thrs = 75 # This avoids blacklisting PRBs where the BWP is scheduled (it’s a workaround bc the UE and gNB would not be able to communicate anymore, a cleaner fix is to move the BWP if needed or things like that)
         self.FFT_SIZE = 1536  
         self.Average_over_frames = 63
-        
-        if ota:
-            dapp_logger.info(f'Using OTA configuration')
-            self.Noise_floor_threshold = 20 # this really depends on the RF conditions and should be carefully calibrated
-        else: # Colosseum
-            dapp_logger.info(f'Using Colosseum configuration')
-            self.Noise_floor_threshold = 53
-
+        self.noise_floor_threshold = noise_floor_threshold
         self.save_iqs = save_iqs
         self.e3_interface.add_callback(self.get_iqs_from_ran)
         if self.save_iqs:
@@ -54,7 +47,7 @@ class SpectrumSharingDApp(DApp):
 
         self.energyGui = kwargs.get('energyGui', False)
         self.iqPlotterGui = kwargs.get('iqPlotterGui', False)
-        self.demoGui = kwargs.get('demoGui', False)
+        self.dashboard = kwargs.get('dashboard', False)
 
         self.control_count = 1
         self.abs_iq_av = np.zeros(self.FFT_SIZE)
@@ -70,11 +63,12 @@ class SpectrumSharingDApp(DApp):
             iq_size = self.FFT_SIZE * 2 # double the size of ofdm_symbol_size since real and imaginary parts are interleaved
             self.iqPlotter = IQPlotter(buffer_size=500, iq_size=iq_size, bw=self.bw, center_freq=self.center_freq)    
 
-        if self.demoGui:
-            from visualization.dashboard import DemoGui
+        if self.dashboard:
+            from visualization.dashboard import Dashboard
             self.demo_queue = multiprocessing.Queue()
             iq_size = self.FFT_SIZE * 2 # double the size of ofdm_symbol_size since real and imaginary parts are interleaved
-            self.demo = DemoGui(buffer_size=100, iq_size=iq_size) 
+            classifier = kwargs.get('classifier', None)
+            self.demo = Dashboard(buffer_size=100, iq_size=iq_size, classifier=classifier) 
 
     def get_iqs_from_ran(self, data):
         dapp_logger.debug(f'Triggered callback')
@@ -93,7 +87,7 @@ class SpectrumSharingDApp(DApp):
         if self.iqPlotterGui:
             self.iq_queue.put(iq_arr)
 
-        if self.demoGui:
+        if self.dashboard:
             self.demo_queue.put(("iq_data", iq_arr))
 
         if self.control:
@@ -106,9 +100,6 @@ class SpectrumSharingDApp(DApp):
             self.control_count += 1
             dapp_logger.debug(f"Control count is: {self.control_count}")
 
-            if self.iqPlotterGui:
-                self.iq_queue.put(iq_arr)
-
             if self.control_count == self.Average_over_frames:
                 abs_iq_av_db =  20 * np.log10(1 + (self.abs_iq_av/(self.Average_over_frames)))
                 abs_iq_av_db_offset_correct = np.append(abs_iq_av_db[self.First_carrier_offset:self.FFT_SIZE],abs_iq_av_db[0:self.First_carrier_offset])
@@ -119,10 +110,9 @@ class SpectrumSharingDApp(DApp):
                 # last_5_max_abs_iq_av_db_offset_correct = np.sort(abs_iq_av_db_offset_correct)[-20:]
                 # dapp_logger.info(f'Last 20 max values (abs_iq_av_db_offset_correct): {last_5_max_abs_iq_av_db_offset_correct}')
 
-
                 # PRB blocking based on the noise floor threshold
                 f_ind = np.arange(self.FFT_SIZE)
-                blklist_sub_carrier = f_ind[abs_iq_av_db_offset_correct > self.Noise_floor_threshold]
+                blklist_sub_carrier = f_ind[abs_iq_av_db_offset_correct > self.noise_floor_threshold]
                 np.sort(blklist_sub_carrier)
                 dapp_logger.info(f'blklist_sub_carrier: {blklist_sub_carrier}')
                 prb_blk_list = np.unique((np.floor(blklist_sub_carrier/self.Num_car_prb))).astype(np.uint16)
@@ -143,7 +133,7 @@ class SpectrumSharingDApp(DApp):
                 if self.energyGui:
                     self.sig_queue.put(abs_iq_av_db)
                 
-                if self.demoGui:
+                if self.dashboard:
                     self.demo_queue.put(("prb_list", prb_blk_list))
 
                 # Reset the variables
@@ -154,10 +144,12 @@ class SpectrumSharingDApp(DApp):
         if self.energyGui:
             abs_iq_av_db = self.sig_queue.get()
             self.energyPlotter.process_iq_data(abs_iq_av_db)
+
         if self.iqPlotterGui:
             iq_data = self.iq_queue.get()
             self.iqPlotter.process_iq_data(iq_data)
-        if self.demoGui:
+
+        if self.dashboard:
             message = self.demo_queue.get()
             self.demo.process_iq_data(message)
 
@@ -165,5 +157,5 @@ class SpectrumSharingDApp(DApp):
         if self.save_iqs:
             self.iq_save_file.close()
         
-        if self.demoGui:
+        if self.dashboard:
             self.demo.stop()

{dapps-0.0.1 → dapps-0.0.2}/src/visualization/dashboard.py

@@ -13,8 +13,8 @@ except ModuleNotFoundError:
                     exit(-1)
 import numpy as np
 
-class DemoGui:
-    def __init__(self, buffer_size=100, iq_size=1536, bw=46.08e6, center_freq=3.6192e9):
+class Dashboard:
+    def __init__(self, buffer_size=100, iq_size=1536, bw=46.08e6, center_freq=3.6192e9, classifier=None):
         # TODO double check killing conditions
         # Flask app setup
         self.app = Flask(__name__)
@@ -30,6 +30,8 @@ class DemoGui:
         # Route setup
         self.app.add_url_rule("/", view_func=self.index)
 
+        self.classifier = classifier if classifier is not None else None
+
         # SocketIO event handlers
         self.socketio.on_event("connect", self.handle_initial_connection)
         self._initialize_plot()
@@ -63,6 +65,7 @@ class DemoGui:
         data_buffer = {
             "magnitude": np.zeros((self.BUFFER_SIZE, iqs_to_show)).tolist(),
             "num_prbs": num_prbs,
+            "predicted_label": self.classifier is not None
         }
         self.socketio.emit("initialize_plot", data_buffer)
 
@@ -88,6 +91,11 @@ class DemoGui:
             if self.sampling_counter >= self.sampling_threshold:
                 magnitude_dB = self._process_iq_data(iq_data)[::-1].tolist() # visualization processing is delegated to client
                 self.socketio.emit("update_plot", {"magnitude": magnitude_dB})
+
+                if self.classifier:
+                    label = self.classifier.predict(iq_data)
+                    self.socketio.emit("update_plot", {"predicted_label": label})
+
                 self.sampling_counter = 0
 
         elif plot == "prb_list":
@@ -101,4 +109,4 @@ class DemoGui:
             self.run_thread.join()
 
 if __name__ == "__main__":
-    server_app = DemoGui()
+    server_app = Dashboard()

{dapps-0.0.1 → dapps-0.0.2}/src/visualization/templates/index.html

@@ -11,6 +11,7 @@
 <body>
     <div id="prbs"></div>
     <div id="magnitude"></div>
+    <div id="predicted_label"></div>
 
     <script>
         var waterfall = [{
@@ -22,7 +23,7 @@
         var waterfallLayout = {
             title: "Magnitude of the Sensed Spectrum",
             xaxis: {
-                title: "OFDM Symbols"
+                title: "Subcarriers of the OFDM Symbol"
             },
             yaxis: {
                 title: "Time samples",
@@ -152,8 +153,18 @@
             }
         };
 
+        var classifierLayout = {
+            title: {
+                text: "Predicted Label: N/A",
+                font: { size: 24 }
+            },
+            xaxis: { visible: false },
+            yaxis: { visible: false }
+        };      
+
         var waterfall_buffer;
         var prbs_buffer;
+        var predictedLabel;
 
         var socket = io.connect('http://' + document.domain + ':' + location.port);
         socket.on('initialize_plot', function (data) {
@@ -163,6 +174,9 @@
             prbs[0].z = prbs_buffer;
             Plotly.newPlot('magnitude', waterfall, waterfallLayout);
             Plotly.newPlot('prbs', prbs, prbsLayout);
+            if(data.predicted_label){
+                Plotly.newPlot("predicted_label", [], classifierLayout);
+            }
         });
 
         socket.on('update_plot', function (data) {
@@ -184,6 +198,11 @@
                 prbs_buffer[0].fill(0);
                 data.prb_list.forEach(index => prbs_buffer[0][index] = 1);
                 Plotly.restyle('prbs', { z: [prbs_buffer] });
+            } else if ('predicted_label' in data) {
+                console.log("Predicted label is: ", data.predicted_label);
+                Plotly.relayout('predicted_label', {
+                    'title.text': `Predicted Label: ${data.predicted_label}`
+                });
             } else {
                 console.error('Error unknown values in data ', data);
             }

dapps-0.0.1/.github/workflows/release.yml

@@ -1,121 +0,0 @@
-name: Publish dApp package to PyPI
-
-on:
-  push:
-    tags:
-      - "*"
-
-jobs:
-  build:
-    name: Build distribution 📦
-    runs-on: ubuntu-latest
-    if: github.repository == 'wineslab/dApp-library'
-
-    steps:
-    - uses: actions/checkout@v4
-      with:
-        persist-credentials: false
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: "3.8"
-    - name: Install pypa/build
-      run: >-
-        python3 -m
-        pip install
-        build
-        --user
-    - name: Build a binary wheel and a source tarball
-      run: python3 -m build
-    - name: Store the distribution packages
-      uses: actions/upload-artifact@v4
-      with:
-        name: python-package-distributions
-        path: dist/
-
-  publish-to-pypi:
-    name: >-
-      Publish to PyPI
-    if: startsWith(github.ref, 'refs/tags/') && github.repository == 'wineslab/dApp-library'
-    needs:
-    - build
-    runs-on: ubuntu-latest
-    environment:
-      name: pypi
-      url: https://pypi.org/p/dapps
-    permissions:
-      id-token: write
-
-    steps:
-    - name: Download all the dists
-      uses: actions/download-artifact@v4
-      with:
-        name: python-package-distributions
-        path: dist/
-    - name: Publish distribution 📦 to PyPI
-      uses: pypa/gh-action-pypi-publish@release/v1
-
-  github-release:
-    name: >-
-      Sign packages with Sigstore and upload them to GitHub Release
-    needs:
-    - publish-to-pypi
-    runs-on: ubuntu-latest
-    if: github.repository == 'wineslab/dApp-library'
-
-    permissions:
-      contents: write
-      id-token: write
-
-    steps:
-    - name: Download all the dists
-      uses: actions/download-artifact@v4
-      with:
-        name: python-package-distributions
-        path: dist/
-    - name: Sign the dists with Sigstore
-      uses: sigstore/gh-action-sigstore-python@v3.0.0
-      with:
-        inputs: >-
-          ./dist/*.tar.gz
-          ./dist/*.whl
-    - name: Create GitHub Release
-      env:
-        GITHUB_TOKEN: ${{ github.token }}
-      run: >-
-        gh release create
-        "$GITHUB_REF_NAME"
-        --repo "$GITHUB_REPOSITORY"
-        --notes ""
-    - name: Upload artifact signatures to GitHub Release
-      env:
-        GITHUB_TOKEN: ${{ github.token }}
-      run: >-
-        gh release upload
-        "$GITHUB_REF_NAME" dist/**
-        --repo "$GITHUB_REPOSITORY"
-
-  publish-to-testpypi:
-    name: Publish to TestPyPI
-    needs:
-    - build
-    runs-on: ubuntu-latest
-    if: github.repository == 'wineslab/dApp-library'
-
-    environment:
-      name: testpypi
-      url: https://test.pypi.org/p/dapps
-
-    permissions:
-      id-token: write
-
-    steps:
-    - name: Download all the dists
-      uses: actions/download-artifact@v4
-      with:
-        name: python-package-distributions
-        path: dist/
-    - name: Publish distribution 📦 to TestPyPI
-      uses: pypa/gh-action-pypi-publish@release/v1
-      with:
-        repository-url: https://test.pypi.org/legacy/

dapps-0.0.1/.github/workflows/tag-on-version-change.yml

@@ -1,49 +0,0 @@
-name: Tag on VERSION change
-
-on:
-  push:
-    branches:
-      - main
-    paths:
-      - 'VERSION'  # Only trigger if VERSION file changes
-
-jobs:
-  create-tag:
-    runs-on: ubuntu-latest
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v4
-      with:
-        fetch-depth: 0  # Ensure we fetch all tags
-
-    - name: Read VERSION file
-      id: get_version
-      run: echo "VERSION=$(cat VERSION | tr -d '[:space:]')" >> $GITHUB_ENV
-
-    - name: Check if tag exists
-      id: check_tag
-      run: |
-        if git rev-parse "refs/tags/$VERSION" >/dev/null 2>&1; then
-          echo "Tag $VERSION already exists. Skipping..."
-          echo "EXISTS=true" >> $GITHUB_ENV
-        else
-          echo "EXISTS=false" >> $GITHUB_ENV
-        fi
-
-    - name: Create and push tag
-      if: env.EXISTS == 'false'
-      run: |
-        git tag $VERSION
-        git push origin $VERSION
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-    - name: Trigger Release Workflow
-      if: github.repository == 'wineslab/dApp-library' && env.EXISTS == 'false'
-      run: |
-        curl -X POST -H "Accept: application/vnd.github.v3+json" \
-          -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
-          https://api.github.com/repos/${{ github.repository }}/actions/workflows/release.yml/dispatches \
-          -d '{"ref": "main"}'
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

dapps-0.0.1/VERSION

@@ -1 +0,0 @@
-0.0.1