Updates for rogue v6

.github/workflows/test-or-deploy.yml

@@ -26,17 +26,17 @@ jobs:
   # Run flake8 on all .py files. Should block deploys to Read The Docs.
   flake8:
     name: Flake8 Tests
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     steps:
       # Checkout the code
       - name: Checkout code
         uses: actions/checkout@v2
 
       # Setup python3
-      - name: setup python 3.8.12
+      - name: setup python 3.12
         uses: actions/setup-python@v2
         with:
-          python-version: 3.8.12
+          python-version: 3.12
 
       # Install flake8 modules
       - name: Install dependencies
@@ -53,7 +53,7 @@ jobs:
   # Validate the server docker image definitions
   docker-definitions:
     name: Docker Definition Tests
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     steps:
       # Checkout the code.
       # We use ssh key authentication to be able to access other private
@@ -70,7 +70,7 @@ jobs:
       - name: Validate the server definitions
         shell: bash
         env:
-          SWH76_TOKEN: ${{ secrets.SWH76_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.SWH76_TOKEN }}
         run: |
           cd docker/server/
           ./validate.sh
@@ -79,18 +79,18 @@ jobs:
   # Documentation automatic build tests
   test-docs:
     name: Documentation Build Tests
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     needs: [flake8, docker-definitions]   # Run only if all checks passed
     steps:
       # Checkout the code
       - name: Checkout code
         uses: actions/checkout@v2
 
-      # Setup python 3.8.12
-      - name: Setup python 3.8.12
+      # Setup python 3.12
+      - name: Setup python 3.12
         uses: actions/setup-python@v2
         with:
-          python-version: 3.8.12
+          python-version: 3.12
 
       # Install requirements, pysmurf, and sphinx
       - name: Install dependencies
@@ -108,7 +108,7 @@ jobs:
   # Server tests
   test-server:
     name: Server Tests
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     needs: [flake8, docker-definitions]   # Run only if all checks passed
     steps:
       # Checkout the code
@@ -182,7 +182,7 @@ jobs:
   # Client tests
   test-client:
     name: Client Tests
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     needs: [flake8, docker-definitions]   # Run only if all checks passed
     steps:
       # Checkout the code
@@ -235,7 +235,7 @@ jobs:
   # Deploy new release notes to GitHub
   deploy-release-notes:
     name: Generate Release Notes
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     needs: [test-docs, test-server, test-client]  # Run only if all tests passed
     if: startsWith(github.ref, 'refs/tags/')      # Run only on tagged releases
     steps:
@@ -252,10 +252,10 @@ jobs:
         run: echo ::set-output name=tag::"${GITHUB_REF#refs/tags/}"
 
       # Setup python3
-      - name: Setup python 3.8.12
+      - name: Setup python 3.12
         uses: actions/setup-python@v2
         with:
-          python-version: 3.8.12
+          python-version: 3.12
 
       # Install dependencies of the releaseGen.py script
       - name: Install dependencies
@@ -275,7 +275,7 @@ jobs:
   # Server docker
   deploy-server:
     name: Build Server Docker Image
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     needs: [test-docs, test-server, test-client]  # Run only if all tests passed
     if: startsWith(github.ref, 'refs/tags/')      # Run only on tagged releases
     steps:
@@ -293,7 +293,7 @@ jobs:
 
       # Login to Dockerhub
       - name: Login to Dockerhub
-        uses: docker/login-action@v1
+        uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: slacrherbst
@@ -307,7 +307,7 @@ jobs:
         id: build
         shell: bash
         env:
-          SWH76_TOKEN: ${{ secrets.SWH76_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.SWH76_TOKEN }}
         run: |
           cd docker/server/
           ./build.sh
@@ -316,7 +316,7 @@ jobs:
   # Client docker
   deploy-client:
     name: Build Client Docker Image
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     needs: [test-docs, test-server, test-client]  # Run only if all tests passed
     if: startsWith(github.ref, 'refs/tags/')      # Run only on tagged releases
     steps:
@@ -336,7 +336,7 @@ jobs:
 
       # Login to Dockerhub
       - name: Login to Dockerhub
-        uses: docker/login-action@v1
+        uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: slacrherbst

CMakeLists.txt

@@ -20,15 +20,15 @@ if (DEFINED ENV{CONDA_PREFIX})
 endif()
 
 # Check cmake version
-cmake_minimum_required(VERSION 2.8)
+cmake_minimum_required(VERSION 3.5)
 include(InstallRequiredSystemLibraries)
 
 # Project name
 project (smurf)
 
 # C/C++
 enable_language(CXX)
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++0x")
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++0x -Wno-deprecated")
 
 #####################################
 # Find Rogue & Support Libraries
@@ -38,7 +38,7 @@ if (DEFINED ENV{ROGUE_DIR})
 else()
    set(Rogue_DIR ${CMAKE_PREFIX_PATH}/lib)
 endif()
-find_package(Rogue)
+find_package(Rogue REQUIRED)
 
 #####################################
 # Setup build
@@ -57,7 +57,7 @@ set_target_properties(smurf PROPERTIES LIBRARY_OUTPUT_DIRECTORY ${PROJECT_SOURCE
 set_target_properties(smurf PROPERTIES PREFIX "")
 
 # Link to rogue core
-TARGET_LINK_LIBRARIES(smurf LINK_PUBLIC ${ROGUE_LIBRARIES})
+TARGET_LINK_LIBRARIES(smurf PUBLIC ${ROGUE_LIBRARIES})
 
 # Setup configuration file
 set(CONF_INCLUDE_DIRS ${PROJECT_SOURCE_DIR}/include)

docker/client/Dockerfile

@@ -1,8 +1,7 @@
-FROM ghcr.io/slaclab/smurf-base:R3.0.3
+FROM ghcr.io/slaclab/smurf-roguev6:R3.1.5
 
-RUN apt-get update && \
-    DEBIAN_FRONTEND=noninteractive \
-    apt-get install -y \
+RUN apt-get update
+RUN apt-get install -y \
     python3-gi \
     python3-gi-cairo \
     python3-cairocffi \
@@ -13,7 +12,7 @@ RUN apt-get update && \
 RUN pip3 install --upgrade pip
 
 RUN pip3 install \
-    scipy==1.8.1 \
+    scipy \
     pandas \
     PyYAML \
     pillow \
@@ -34,15 +33,6 @@ RUN mkdir -p /usr/local/src/pysmurf_utilities
 ADD scripts/* /usr/local/src/pysmurf_utilities/
 ENV PATH /usr/local/src/pysmurf_utilities:${PATH}
 
-# By default EPICS is configured with 'EPICS_CA_AUTO_ADDR_LIST=YES'
-# which will cause problems is we have multiple NIC, so let's set it
-# to use localhost only for now
-ENV EPICS_CA_AUTO_ADDR_LIST NO
-ENV EPICS_CA_ADDR_LIST localhost
-
-# Default EPICS prefix value
-ENV EPICS_PREFIX "smurf_server"
-
 # Set GTK3Agg as the matplotlib backend
 ENV MPLBACKEND GTK3Agg
 

docker/client/build.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+docker image build --build-arg branch=rogue_v6 -t roguev6_docker_client .

docker/client/scripts/pysmurf_startup.py

@@ -5,9 +5,6 @@
 import matplotlib.pyplot as plt
 import pysmurf.client
 
-# The epics prefix is defined in the environmental variable 'EPICS_PREFIX'
-epics_prefix = os.getenv('EPICS_PREFIX')
-
 # The path to the default configuration file, if any, is defined
 # in the environmental variable 'CONFIG_FILE'
 config_file = os.getenv('CONFIG_FILE')

docker/client/scripts/start_client.sh

@@ -75,4 +75,4 @@ if [ ! -z ${config_file+x} ]; then
 fi
 
 echo "Starting the ipython session"
-ipython3 -i /usr/local/src/pysmurf_utilities/pysmurf_startup.py
+ipython3 -i /usr/local/src/pysmurf_utilities/pysmurf_startup.py

docker/server/Dockerfile

@@ -1,15 +1,16 @@
-FROM ghcr.io/slaclab/smurf-rogue:R3.10.5
+FROM ghcr.io/slaclab/smurf-roguev6:R3.1.5
 
 # Copy all firmware related files, which are in the local_files directory
 RUN mkdir -p /tmp/fw/ && chmod -R a+rw /tmp/fw/
 COPY local_files /tmp/fw/
 
 # Install the SMURF PCIe card repository
 WORKDIR /usr/local/src
-RUN git clone https://github.com/slaclab/smurf-pcie.git -b v2.0.0.1
+RUN git clone https://github.com/slaclab/smurf-pcie.git -b v3.1.1
 WORKDIR smurf-pcie
 RUN git submodule sync && git submodule update --init --recursive
 ENV PYTHONPATH /usr/local/src/smurf-pcie/software/python:${PYTHONPATH}
+ENV PYTHONPATH /usr/local/src/smurf-pcie/firmware/python:${PYTHONPATH}
 ENV PYTHONPATH /usr/local/src/smurf-pcie/firmware/submodules/axi-pcie-core/python:${PYTHONPATH}
 
 # Install pysmurf
@@ -24,7 +25,7 @@ USER root
 WORKDIR pysmurf
 RUN mkdir build
 WORKDIR build
-RUN cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo .. && make -j4
+RUN cmake -DCMAKE_PREFIX_PATH=/usr/local/lib .. && make -j4
 ENV PYTHONPATH /usr/local/src/pysmurf/lib:${PYTHONPATH}
 ENV PYTHONPATH /usr/local/src/pysmurf/python:${PYTHONPATH}
 ENV SMURF_DIR /usr/local/src/pysmurf

docker/server/build.sh

@@ -54,14 +54,14 @@ git -C local_files clone -c advice.detachedHead=false ${config_repo} -b ${config
 # Build the docker image. This same image will be pushed to both the stable
 # and the base dockerhub repositories.
 echo "Building docker image..."
-docker image build --build-arg branch=${tag} -t docker_image . || exit 1
+docker image build --build-arg branch=${tag} -t pysmurf_server . || exit 1
 
 # Tag and push the image to the stable dockerhub repository
-docker image tag docker_image ${dockerhub_org_name}/${dockerhub_repo_stable}:${tag}
+docker image tag pysmurf_server ${dockerhub_org_name}/${dockerhub_repo_stable}:${tag}
 docker image push ${dockerhub_org_name}/${dockerhub_repo_stable}:${tag}
 echo "Docker image '${dockerhub_org_name}/${dockerhub_repo_stable}:${tag}' pushed"
 
 # Tag and push the image to the stable dockerhub repository
-docker image tag docker_image ${dockerhub_org_name}/${dockerhub_repo_base}:${tag}
+docker image tag pysmurf_server ${dockerhub_org_name}/${dockerhub_repo_base}:${tag}
 docker image push ${dockerhub_org_name}/${dockerhub_repo_base}:${tag}
 echo "Docker image '${dockerhub_org_name}/${dockerhub_repo_base}:${tag}' pushed"

docker/server/scripts/server_common.sh

@@ -406,7 +406,7 @@ validateCommType()
         comm_type='eth'
     else
         # Check if the communication type is invalid
-        if [ ${comm_type} != 'eth' ] && [ ${comm_type} != 'pcie' ]; then
+        if [ ${comm_type} != 'eth' ] && [ ${comm_type} != 'pcie' ] && [ ${comm_type} != 'emu' ]; then
             echo "Invalid communication type!."
             usage
         fi
@@ -665,11 +665,9 @@ detect_amc_board()
             elif [ ${type_str} == "A02" ]; then
                 echo "This is a HB board."
                 band_bay[$i]="hb"
-		system_type="umux"
             elif [ ${type_str} == "A03" ]; then
                 echo "This is a TKID board."
                 band_bay[$i]="tkid"
-		system_type="tkid"
             else
                 echo "Board type not supported."
                 echo

docker/server/scripts/start_server.sh

@@ -30,6 +30,9 @@ echo
 if [ ${comm_type} == 'eth' ]; then
     echo "Staring the server using Ethernet communication..."
     cmd="/usr/local/src/pysmurf/server_scripts/cmb_eth.py  ${args}"
+elif [ ${comm_type} == 'emu' ]; then
+    echo "Staring the server using Emulation..."
+    cmd="/usr/local/src/pysmurf/server_scripts/emulate.py  ${args}"
 else
     echo "Staring the server using PCIe communication..."
     cmd="/usr/local/src/pysmurf/server_scripts/cmb_pcie.py ${args}"

docker/server/validate.sh

@@ -1,6 +1,7 @@
 #!/usr/bin/env bash
 
 # Validate definitions.sh
+# RTH: Replaced AER7_TOKEN with GITHUB_TOKEN
 
 #############
 # FUNCTIONS #
@@ -54,7 +55,7 @@ check_if_private_tag_exist()
     # Big blob of JSON with the tags in it.
     local tags=$(curl \
       --url $api_url \
-      --header "Authorization: token ${SWH76_TOKEN}" \
+      --header "Authorization: token ${GITHUB_TOKEN}" \
       --fail)
 
     # e.g. 0 if no match
@@ -80,7 +81,7 @@ check_if_private_asset_exist()
     local file=$3
 
     # Search the asset ID in the specified release
-    local r=$(curl --silent --header "Authorization: token ${SWH76_TOKEN}" "${repo}/releases/tags/${tag}")
+    local r=$(curl --silent --header "Authorization: token ${GITHUB_TOKEN}" "${repo}/releases/tags/${tag}")
     eval $(echo "${r}" | grep -C3 "name.:.\+${file}" | grep -w id | tr : = | tr -cd '[[:alnum:]]=')
 
     # return is the asset tag was found
@@ -106,7 +107,7 @@ get_private_asset()
 
     # Try to download the asset
     curl --fail --location --remote-header-name --remote-name --progress-bar \
-         --header "Authorization: token ${SWH76_TOKEN}" \
+         --header "Authorization: token ${GITHUB_TOKEN}" \
          --header "Accept: application/octet-stream" \
          "${repo}/releases/assets/${id}"
 }