Merge pull request #43 from analogdevicesinc/doc-spectral-analysis

Doc cleanup and a new page on spectral analysis using Genalyzer
analogdevicesinc · Nov 4, 2024 · ec4523a · ec4523a
2 parents ac2ad93 + 4aadb21
commit ec4523a
Show file tree

Hide file tree

Showing 82 changed files with 7,340 additions and 6,810 deletions.
diff --git a/.github/workflows/deploy-pypi-testing.yml b/.github/workflows/deploy-pypi-testing.yml
@@ -7,9 +7,9 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python 3.7
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: 3.7
 

diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
@@ -7,11 +7,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python 3.7
-        uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.7
+          python-version: '3.10'
 
       - name: Install dependencies
         run: |
@@ -23,6 +23,15 @@ jobs:
           mkdir -p build
           cd build
           cmake .. -DBUILD_DOC=ON
+          make genalyzer -j4
+          sudo make install genalyzer
+          sudo ldconfig
+          cd ../bindings/python
+          pip install ".[tools]"
+          cd ../../build
+          sudo rm -rf *
+          sudo rm ../doc/reference_simplified.md
+          cmake .. -DBUILD_DOC=ON
           make Sphinx
 
 
@@ -32,11 +41,11 @@ jobs:
     if: github.ref == 'refs/heads/main'
 
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python 3.7
-        uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.7
+          python-version: '3.10'
 
       - name: Install dependencies
         run: |

diff --git a/.github/workflows/test-win.yml b/.github/workflows/test-win.yml
@@ -7,9 +7,9 @@ jobs:
     runs-on: windows-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python 3.7
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: 3.7
 
@@ -54,7 +54,7 @@ jobs:
           ctest -V -C Release
 
       - name: Archive generated DLLs
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: DLLs
           path: src\Release\
@@ -63,9 +63,9 @@ jobs:
     runs-on: windows-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python 3.7
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: 3.7
 
@@ -113,13 +113,13 @@ jobs:
         shell: cmd
 
       - name: Archive Windows exe installer
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: EXE-Installer
           path: C:\genalyzer-setup.exe
 
       - name: Download artifact installer
-        uses: actions/download-artifact@v1
+        uses: actions/download-artifact@v4
         with:
           name: EXE-Installer
           path: win_build

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -20,9 +20,9 @@ jobs:
     container:
       image: ${{ matrix.images }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python 3.7
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: 3.7
 
@@ -42,11 +42,11 @@ jobs:
           cp build/bindings/c/src/libgenalyzer.so* libs/
           cp build/src/libgenalyzer_plus_plus.a* libs/
           cp bindings/c/include/cgenalyzer.h libs/
-          cp bindings/c/include/cgenalyzer_advanced.h libs/
+          cp bindings/c/include/cgenalyzer_simplified_beta.h libs/
           cp bindings/matlab/genalyzer.m libs/
 
       - name: Archive generated SOs
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ matrix.label }}-Build
           path: libs/
@@ -61,7 +61,7 @@ jobs:
 #    container:
 #      image: ${{ matrix.images }}
 #    steps:
-#      - uses: actions/checkout@v2
+#      - uses: actions/checkout@v4
 #      - name: Install dependencies
 #        run: |
 #          bash ./.github/scripts/install_dependencies_rhel.sh
@@ -78,11 +78,11 @@ jobs:
 #          cp build/bindings/c/src/libgenalyzer.so* libs/
 #          cp build/src/libgenalyzer_plus_plus.a* libs/
 #          cp bindings/c/include/cgenalyzer.h libs/
-#          cp bindings/c/include/cgenalyzer_advanced.h libs/
+#          cp bindings/c/include/cgenalyzer_simplified_beta.h libs/
 #          cp bindings/matlab/genalyzer.m libs/
 
 #      - name: Archive generated SOs
-#        uses: actions/upload-artifact@v2
+#        uses: actions/upload-artifact@v4
 #        with:
 #          name: RHEL_7-Build
 #          path: libs/
@@ -91,9 +91,9 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python 3.7
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
         with:
           python-version: 3.7
 
@@ -111,17 +111,17 @@ jobs:
           make coverage
 
       - name: Coveralls
-        uses: coverallsapp/github-action@v1
+        uses: coverallsapp/github-action@v2
         with:
           path-to-lcov: build/main_coverage.info
 
   TestCMacOS:
     runs-on: macos-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python 3.8
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: 3.8
 
@@ -143,9 +143,9 @@ jobs:
         python-version: [3.7, 3.8, 3.9]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
 

diff --git a/bindings/c/include/CMakeLists.txt b/bindings/c/include/CMakeLists.txt
@@ -1 +1 @@
-install(FILES cgenalyzer.h cgenalyzer_advanced.h DESTINATION include/)
+install(FILES cgenalyzer_simplified_beta.h cgenalyzer.h DESTINATION include/)