Merge branch 'main' into http-camera-agent

simonsobs · Aug 16, 2024 · f677be9 · f677be9
2 parents 94e9641 + d8b902e
commit f677be9
Show file tree

Hide file tree

Showing 69 changed files with 928 additions and 165 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -29,7 +29,7 @@ jobs:
     # Dockerize
     - name: Build docker images
       run: |
-        docker-compose build
+        docker compose build
 
     - name: Login to Docker Hub
       uses: docker/login-action@v3
@@ -44,13 +44,13 @@ jobs:
         export DOCKER_TAG=`git describe --tags --always`
 
         # Tag all images for upload to the registry
-        docker-compose config | grep 'image: ' | awk -F ': ' '{ print $2 }' | xargs -I {} docker tag {}:latest ${DOCKERHUB_ORG}/{}:latest
-        docker-compose config | grep 'image: ' | awk -F ': ' '{ print $2 }' | xargs -I {} docker tag {}:latest ${DOCKERHUB_ORG}/{}:${DOCKER_TAG}
+        docker compose config | grep 'image: ' | awk -F ': ' '{ print $2 }' | xargs -I {} docker tag {}:latest ${DOCKERHUB_ORG}/{}:latest
+        docker compose config | grep 'image: ' | awk -F ': ' '{ print $2 }' | xargs -I {} docker tag {}:latest ${DOCKERHUB_ORG}/{}:${DOCKER_TAG}
 
         # Upload to docker registry
-        docker-compose config | grep 'image: ' | awk -F ': ' '{ print $2 }' | xargs -I {} docker push ${DOCKERHUB_ORG}/{}:latest
-        docker-compose config | grep 'image: ' | awk -F ': ' '{ print $2 }' | xargs -I {} docker push ${DOCKERHUB_ORG}/{}:${DOCKER_TAG}
-        docker-compose config | grep 'image: ' | awk -F ': ' '{ print $2 }' | xargs -I {} echo ${DOCKERHUB_ORG}/{}:${DOCKER_TAG} pushed
+        docker compose config | grep 'image: ' | awk -F ': ' '{ print $2 }' | xargs -I {} docker push ${DOCKERHUB_ORG}/{}:latest
+        docker compose config | grep 'image: ' | awk -F ': ' '{ print $2 }' | xargs -I {} docker push ${DOCKERHUB_ORG}/{}:${DOCKER_TAG}
+        docker compose config | grep 'image: ' | awk -F ': ' '{ print $2 }' | xargs -I {} echo ${DOCKERHUB_ORG}/{}:${DOCKER_TAG} pushed
 
   wheel:
     name: build and deploy to PyPI

diff --git a/.github/workflows/develop.yml b/.github/workflows/develop.yml
@@ -31,7 +31,7 @@ jobs:
     # Dockerize
     - name: Build docker images
       run: |
-        docker-compose build
+        docker compose build
 
     - name: Login to Docker Hub
       uses: docker/login-action@v3
@@ -47,11 +47,11 @@ jobs:
         echo "${DOCKER_TAG}"
 
         # Tag all images for upload to the registry
-        docker-compose config | grep 'image: ' | awk -F ': ' '{ print $2 }' | xargs -I {} docker tag {}:latest ${DOCKERHUB_ORG}/{}:${DOCKER_TAG}
+        docker compose config | grep 'image: ' | awk -F ': ' '{ print $2 }' | xargs -I {} docker tag {}:latest ${DOCKERHUB_ORG}/{}:${DOCKER_TAG}
 
         # Upload to docker registry
-        docker-compose config | grep 'image: ' | awk -F ': ' '{ print $2 }' | xargs -I {} docker push ${DOCKERHUB_ORG}/{}:${DOCKER_TAG}
-        docker-compose config | grep 'image: ' | awk -F ': ' '{ print $2 }' | xargs -I {} echo ${DOCKERHUB_ORG}/{}:${DOCKER_TAG} pushed
+        docker compose config | grep 'image: ' | awk -F ': ' '{ print $2 }' | xargs -I {} docker push ${DOCKERHUB_ORG}/{}:${DOCKER_TAG}
+        docker compose config | grep 'image: ' | awk -F ': ' '{ print $2 }' | xargs -I {} echo ${DOCKERHUB_ORG}/{}:${DOCKER_TAG} pushed
 
   # testing so we can catch any issues before release
   # if issues are found, test locally, or copy to pytest.yml for test on push

diff --git a/.github/workflows/pytest.yml b/.github/workflows/pytest.yml
@@ -53,7 +53,7 @@ jobs:
 
     - name: Build docker test images
       run: |
-        docker-compose build socs
+        docker compose build socs
 
     # Integration Tests
     - name: Run integration tests

diff --git a/.github/workflows/test-build.yml b/.github/workflows/test-build.yml
@@ -26,4 +26,4 @@ jobs:
     # Dockerize
     - name: Build docker images
       run: |
-        docker-compose build
+        docker compose build
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -12,10 +12,10 @@ repos:
     - id: isort
       name: isort (python)
 -   repo: https://github.com/hhatto/autopep8
-    rev: v2.2.0
+    rev: v2.3.1
     hooks:
     -   id: autopep8
 -   repo: https://github.com/pycqa/flake8
-    rev: 7.0.0
+    rev: 7.1.1
     hooks:
     -   id: flake8
diff --git a/Dockerfile b/Dockerfile
@@ -2,7 +2,7 @@
 # A container setup with an installation of socs.
 
 # Use the ocs image as a base
-FROM simonsobs/ocs:v0.11.0
+FROM simonsobs/ocs:v0.11.1-1-gb6cbd88
 
 # Set up the cryo/smurf user and group so this can run on smurf-servers
 # See link for how all other smurf-containers are set up:
@@ -16,10 +16,9 @@ RUN useradd -d /home/cryo -M cryo -u 1000 && \
 
 # Install packages
 # suprsync agent - rsync
-# labjack agent - wget, python3-pip, libusb-1.0-0-dev, udev
+# labjack agent - wget, libusb-1.0-0-dev, udev
 RUN apt-get update && apt-get install -y rsync \
     wget \
-    python3-pip \
     libusb-1.0-0-dev \
     udev
 
@@ -35,13 +34,15 @@ RUN ./labjack_ljm_software_2020_03_30_x86_64/labjack_ljm_installer.run -- --no-r
 COPY requirements/ /app/socs/requirements
 COPY requirements.txt /app/socs/requirements.txt
 WORKDIR /app/socs/
-RUN pip3 install -r requirements.txt
+# Work around https://github.com/pypa/setuptools/issues/4483/ temporarily
+RUN python -m pip install -U "setuptools<71.0.0"
+RUN python -m pip install -r requirements.txt
 
 # Copy the current directory contents into the container at /app
 COPY . /app/socs/
 
 # Install socs
-RUN pip3 install .
+RUN python -m pip install .
 
 # Reset workdir to avoid local imports
 WORKDIR /

diff --git a/docs/agents/bluefors_agent.rst b/docs/agents/bluefors_agent.rst
@@ -38,7 +38,7 @@ An example configuration for your ocs config file::
 Docker Compose
 ``````````````
 
-Example docker-compose configuration::
+Example docker compose configuration::
 
   ocs-bluefors:
     image: simonsobs/socs:latest
@@ -145,7 +145,7 @@ tools, i.e. Docker for Windows, if possible) is:
 - Run docker terminal (this performs some Virtualbox setup)
 - Run docker login
 - Clone the ocs-site-configs repo and create a directory for your machine
-- Configure ocs/docker-compose files
+- Configure ocs/docker compose files
 - Make sure your system clock is set to UTC
 - Bring up the container(s)
 

diff --git a/docs/agents/cryomech_cpa.rst b/docs/agents/cryomech_cpa.rst
@@ -47,7 +47,7 @@ Docker Compose
 ``````````````
 
 The Cryomech CPA Agent should be configured to run in a Docker container.
-An example docker-compose service configuration is shown here::
+An example docker compose service configuration is shown here::
 
   ocs-ptc1:
     image: simonsobs/socs:latest

diff --git a/docs/agents/generator.rst b/docs/agents/generator.rst
@@ -45,7 +45,7 @@ Docker Compose
 ``````````````
 
 The Generator Agent should be configured to run in a Docker container. An
-example docker-compose service configuration is shown here::
+example docker compose service configuration is shown here::
 
   ocs-generator:
     image: simonsobs/socs:latest

diff --git a/docs/agents/hi6200.rst b/docs/agents/hi6200.rst
@@ -44,7 +44,7 @@ Docker Compose
 ``````````````
 
 The SCPI PSU Agent should be configured to run in a Docker container.
-An example docker-compose service configuration is shown here::
+An example docker compose service configuration is shown here::
 
   ocs-hi6200:
     image: simonsobs/socs:latest

diff --git a/docs/agents/hwp_encoder.rst b/docs/agents/hwp_encoder.rst
@@ -49,7 +49,7 @@ Docker Compose
 ``````````````
 
 The CHWP BBB agent can be run via a Docker container. The following is an
-example of what to insert into your institution's docker-compose file.
+example of what to insert into your institution's docker compose file.
 This again is an example to run multiple agents::
 
   ocs-hwpbbb-agent-HBA0:

diff --git a/docs/agents/hwp_gripper.rst b/docs/agents/hwp_gripper.rst
@@ -39,7 +39,7 @@ An example site-config-file block::
 Docker Compose
 `````````````````````
 
-An example docker-compose configuration::
+An example docker compose configuration::
 
     ocs-hwp-gripper:
         image: simonsobs/socs:latest

diff --git a/docs/agents/hwp_pcu.rst b/docs/agents/hwp_pcu.rst
@@ -55,8 +55,7 @@ configuration block that will automatically start data acquisition::
 
   {'agent-class': 'HWPPCUAgent',
    'instance-id': 'hwp-pcu',
-   'arguments': [['--port', '/dev/HWPPCU'],
-                 ['--mode', 'acq']]},
+   'arguments': ['--port', '/dev/HWPPCU']},
 
 Each device requires configuration under 'agent-instances'. See the OCS site
 configs documentation for more details.

diff --git a/docs/agents/hwp_picoscope.rst b/docs/agents/hwp_picoscope.rst
@@ -55,7 +55,7 @@ Docker
     yourself. A Dockerfile is provided in ``socs/docker/hwp_picoscope/``.
 
 The HWP picoscope agent can be run via a Docker container. The following is an
-example of what to insert into your institution's docker-compose file::
+example of what to insert into your institution's docker compose file::
 
   picoscope:
     image: ocs-hwp-picoscope-agent:latest

diff --git a/docs/agents/hwp_pid.rst b/docs/agents/hwp_pid.rst
@@ -30,7 +30,7 @@ An example site-config-file block::
 Docker Compose
 ``````````````
 
-An example docker-compose configuration::
+An example docker compose configuration::
 
   ocs-hwp-pid:
     image: simonsobs/socs:latest

diff --git a/docs/agents/hwp_pmx.rst b/docs/agents/hwp_pmx.rst
@@ -32,7 +32,7 @@ An example site-config-file block::
 Docker Compose
 ``````````````
 
-An example docker-compose configuration::
+An example docker compose configuration::
 
   ocs-hwp-pmx:
     image: simonsobs/socs:latest

diff --git a/docs/agents/hwp_supervisor_agent.rst b/docs/agents/hwp_supervisor_agent.rst
@@ -129,6 +129,17 @@ current action will be aborted at the next opportunity and replaced with the new
 requested action.  The ``abort_action`` task can be used to abort the current
 action without beginning a new one.
 
+ACU Safety Checks
+```````````````````
+
+If the ACU instance-id is provided in the site-config, the supervisor will check
+the ACU state before spin-up or gripping procedures to ensure the telescope is
+in a safe state to perform the specified operation.
+
+Before spinning up the HWP, the agent will check that
+- The current elevation and commanded elevation are in the range ``(acu-min-el, acu-max-el)``.
+- The ACU state info has been updated within ``acu-max-time-since-update`` seconds.
+
 Examples
 ```````````
 Below is an example client script that runs the PID to freq operation, and waits

diff --git a/docs/agents/ibootbar.rst b/docs/agents/ibootbar.rst
@@ -41,7 +41,7 @@ Docker Compose
 ``````````````
 
 The iBootbar Agent should be configured to run in a Docker container. An
-example docker-compose service configuration is shown here::
+example docker compose service configuration is shown here::
 
   ocs-ibootbar:
     image: simonsobs/socs:latest

diff --git a/docs/agents/ifm_sbn246_flowmeter.rst b/docs/agents/ifm_sbn246_flowmeter.rst
@@ -43,7 +43,7 @@ Docker Compose
 ``````````````
 
 The IFM SBN246 Flowmeter Agent should be configured to run in a Docker
-container. An example docker-compose service configuration is shown here::
+container. An example docker compose service configuration is shown here::
 
   ocs-flow:
     image: simonsobs/socs:latest

diff --git a/docs/agents/labjack.rst b/docs/agents/labjack.rst
@@ -102,7 +102,7 @@ Docker Compose
 ``````````````
 
 The LabJack Agent should be configured to run in a Docker container. An
-example docker-compose service configuration is shown here::
+example docker compose service configuration is shown here::
 
   ocs-labjack:
     image: simonsobs/socs:latest

diff --git a/docs/agents/lakeshore425.rst b/docs/agents/lakeshore425.rst
@@ -38,7 +38,7 @@ If you would like to chanege the setting or check the status of the lakeshore 42
 Docker Compose
 ``````````````
 The ocs-lakeshore425-agent can be run via a Docker container. The following is an
-example of what to insert into your institution's docker-compose file.::
+example of what to insert into your institution's docker compose file.::
 
   ocs-lakeshore425-agent:
     image: simonsobs/socs:latest

diff --git a/docs/agents/magpie.rst b/docs/agents/magpie.rst
@@ -22,7 +22,7 @@ frame is received.
 Configuration File Examples
 ------------------------------
 
-Below are example docker-compose and ocs configuration files for running the
+Below are example docker compose and ocs configuration files for running the
 magpie agent.
 
 OCS Site Config
@@ -67,7 +67,7 @@ fake data by adding the ``--fake-data`` argument.
 Docker Compose
 ``````````````````
 
-Below is an example docker-compose entry for running a magpie corresponding to
+Below is an example docker compose entry for running a magpie corresponding to
 crate-id 1 and slot 2. If crossbar is being run on a different server, you'll
 have to modify the ``site-hub`` and ``site-http`` args accordingly::
 

diff --git a/docs/agents/meinberg_m1000_agent.rst b/docs/agents/meinberg_m1000_agent.rst
@@ -72,7 +72,7 @@ Docker Compose
 ``````````````
 
 The Meinberg M1000 Agent should be configured to run in a Docker container. An
-example docker-compose service configuration is shown here::
+example docker compose service configuration is shown here::
 
   ocs-m1000:
     image: simonsobs/socs:latest

diff --git a/docs/agents/meinberg_syncbox_agent.rst b/docs/agents/meinberg_syncbox_agent.rst
@@ -43,7 +43,7 @@ Docker Compose
 ``````````````
 
 The Meinberg Syncbox Agent should be configured to run in a Docker container. An
-example docker-compose service configuration is shown here::
+example docker compose service configuration is shown here::
 
   ocs-timing-syncbox:
     image: simonsobs/socs:latest

diff --git a/docs/agents/pfeiffer.rst b/docs/agents/pfeiffer.rst
@@ -44,7 +44,7 @@ Docker Compose
 ``````````````
 
 The Pfeiffer Agent can be run via a Docker container. The following is an
-example of what to insest into your institution's docker-compose file. ::
+example of what to insest into your institution's docker compose file. ::
 
 
   ocs-pfeiffer:

diff --git a/docs/agents/pfeiffer_tc400.rst b/docs/agents/pfeiffer_tc400.rst
@@ -54,7 +54,7 @@ block using all of the available arguments::
 Docker Compose
 ``````````````
 The agent should be configured to run in a Docker container. An
-example docker-compose service configuration is shown here::
+example docker compose service configuration is shown here::
 
   ocs-pfeiffer-turboA:
     image: simonsobs/socs:latest

diff --git a/docs/agents/pysmurf-controller.rst b/docs/agents/pysmurf-controller.rst
@@ -64,7 +64,7 @@ mount in a development copy of SODETLIB so that we have the most recent version
 without having to rebuild this container.
 
 
-The docker-compose for the pysmurf-controller that publishes to a container
+The docker compose for the pysmurf-controller that publishes to a container
 named ``ocs-pysmurf-monitor`` might look something like::
 
     ocs-pysmurf:

diff --git a/docs/agents/pysmurf-monitor.rst b/docs/agents/pysmurf-monitor.rst
@@ -31,7 +31,7 @@ Example site-config entry::
 
 Docker Compose
 ````````````````
-An example docker-compose entry might look like::
+An example docker compose entry might look like::
 
     ocs-pysmurf-monitor:
         image: simonsobs/socs:latest
@@ -48,7 +48,7 @@ An example docker-compose entry might look like::
             - /data:/data
 
 Where SOCS_TAG and CB_HOST are set in the ``.env`` file in the same dir as the
-docker-compose file.
+docker compose file.
 
 Description
 -----------

diff --git a/docs/agents/scpi_psu.rst b/docs/agents/scpi_psu.rst
@@ -46,7 +46,7 @@ Docker Compose
 ``````````````
 
 The SCPI PSU Agent should be configured to run in a Docker container.
-An example docker-compose service configuration is shown here::
+An example docker compose service configuration is shown here::
 
   ocs-psuK:
     image: simonsobs/socs:latest

diff --git a/docs/agents/smurf_crate_monitor.rst b/docs/agents/smurf_crate_monitor.rst
@@ -55,7 +55,7 @@ steps:
 4. Copy ocs-user ssh key using 'ssh-copy-id'
 
 You also need to add the ocs-base anchor and mount the home directory of
-the ocs-user in your 'docker-compose' file, see below for an example.
+the ocs-user in your 'docker compose' file, see below for an example.
 
 The second argument, 'crate-id', is just an identifier for your feed names
 to distinguish between identical sensors on different crates.
@@ -64,7 +64,7 @@ Docker Compose
 ``````````````
 
 The SMuRF Crate Agent should be configured to run in a Docker container. An
-example docker-compose service configuration is shown here::
+example docker compose service configuration is shown here::
 
   ocs-smurf-crate-monitor:
     <<: *ocs-base

diff --git a/docs/agents/smurf_timing_card.rst b/docs/agents/smurf_timing_card.rst
@@ -16,7 +16,7 @@ timing software.
 Configuration File Examples
 ------------------------------
 Below are configuration examples for the ocs config file and for the
-docker-compose service.
+docker compose service.
 
 OCS Site Config
 `````````````````
@@ -36,7 +36,7 @@ False by default.
 
 Docker Compose
 ````````````````
-Below is an example of the docker-compose service for the timing card agent::
+Below is an example of the docker compose service for the timing card agent::
 
     ocs-smurf-timing-card:
         image: simonsobs/socs:latest