mx-bluesky 1.5.15__tar.gz → 1.6.3__tar.gz

{mx_bluesky-1.5.15 → mx_bluesky-1.6.3}/.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: 4.3.0
+_commit: 5.0.1
 _src_path: gh:DiamondLightSource/python-copier-template
 author_email: dominic.oram@diamond.ac.uk
 author_name: Dominic Oram

{mx_bluesky-1.5.15 → mx_bluesky-1.6.3}/.devcontainer/devcontainer.json

@@ -7,13 +7,29 @@
     },
     "remoteEnv": {
         // Allow X11 apps to run inside the container
-        "DISPLAY": "${localEnv:DISPLAY}"
+        "DISPLAY": "${localEnv:DISPLAY}",
+        // Put things that allow it in the persistent cache
+        "PRE_COMMIT_HOME": "/cache/pre-commit",
+        "UV_CACHE_DIR": "/cache/uv",
+        "UV_PYTHON_CACHE_DIR": "/cache/uv-python",
+        // Make a venv that is specific for this workspace path as the cache is shared
+        "UV_PROJECT_ENVIRONMENT": "/cache/venv-for${localWorkspaceFolder}",
+        // Do the equivalent of "activate" the venv so we don't have to "uv run" everything
+        "VIRTUAL_ENV": "/cache/venv-for${localWorkspaceFolder}",
+        "PATH": "/cache/venv-for${localWorkspaceFolder}/bin:${containerEnv:PATH}"
     },
     "customizations": {
         "vscode": {
             // Set *default* container specific settings.json values on container create.
             "settings": {
-                "python.defaultInterpreterPath": "/venv/bin/python"
+                // Use the container's python by default
+                "python.defaultInterpreterPath": "/cache/venv-for${localWorkspaceFolder}/bin/python",
+                // Don't activate the venv as it is already in the PATH
+                "python.terminal.activateEnvInCurrentTerminal": false,
+                "python.terminal.activateEnvironment": false,
+                // Workaround to prevent garbled python REPL in the terminal
+                // https://github.com/microsoft/vscode-python/issues/25505
+                "python.terminal.shellIntegration.enabled": false
             },
             // Add the IDs of extensions you want installed when the container is created.
             "extensions": [
@@ -53,23 +69,33 @@
             "python.analysis.typeCheckingMode": "basic"
         }
     },
-    "features": {
-        // add in eternal history and other bash features
-        "ghcr.io/diamondlightsource/devcontainer-features/bash-config:1": {}
-    },
-    // Create the config folder for the bash-config feature
-    "initializeCommand": "mkdir -p ${localEnv:HOME}/.config/bash-config",
+    // Create the config folder for the bash-config feature and uv cache
+    "initializeCommand": "mkdir -p ${localEnv:HOME}/.config/terminal-config",
     "runArgs": [
         // Allow the container to access the host X11 display and EPICS CA
         "--net=host",
         // Make sure SELinux does not disable with access to host filesystems like tmp
         "--security-opt=label=disable"
     ],
+    "mounts": [
+        // Mount in the user terminal config folder so it can be edited
+        {
+            "source": "${localEnv:HOME}/.config/terminal-config",
+            "target": "/user-terminal-config",
+            "type": "bind"
+        },
+        // Keep a persistent cross container cache for uv, pre-commit, and the venvs
+        {
+            "source": "devcontainer-shared-cache",
+            "target": "/cache",
+            "type": "volume"
+        }
+    ],
     // Mount the parent as /workspaces so we can pip install peers as editable
     "workspaceMount": "source=${localWorkspaceFolder}/..,target=/workspaces,type=bind",
     "mounts": [
         "source=/dls_sw/apps/dials/latest/latest/modules/dlstbx/src/dlstbx/,target=/dls_sw/apps/dials/latest/latest/modules/dlstbx/src/dlstbx/,type=bind,consistency=cached"
     ],
-    // After the container is created, install the python project in editable form
-    "postCreateCommand": "pip install $([ -f dev-requirements.txt ] && echo '-c dev-requirements.txt') -e '.[dev]' && pip install -e /workspaces/dodal[dev] && pre-commit install && ln -s /dls_sw/apps/dials/latest/latest/modules/dlstbx/src/dlstbx/ /venv/lib/python3.12/site-packages/dlstbx"
+    // After the container is created, recreate the venv then make pre-commit first run faster
+    "postCreateCommand": "uv venv --clear && uv sync && pre-commit install --install-hooks"
 }

{mx_bluesky-1.5.15 → mx_bluesky-1.6.3}/.github/CONTRIBUTING.md

@@ -73,4 +73,4 @@ It is recommended that developers use a [vscode devcontainer](https://code.visua
 
 This project was created using the [Diamond Light Source Copier Template](https://github.com/DiamondLightSource/python-copier-template) for Python projects.
 
-For more information on common tasks like setting up a developer environment, running the tests, and setting a pre-commit hook, see the template's [How-to guides](https://diamondlightsource.github.io/python-copier-template/4.3.0/how-to.html).
+For more information on common tasks like setting up a developer environment, running the tests, and setting a pre-commit hook, see the template's [How-to guides](https://diamondlightsource.github.io/python-copier-template/5.0.1/how-to.html).

{mx_bluesky-1.5.15 → mx_bluesky-1.6.3}/.github/workflows/_container.yml

@@ -11,7 +11,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           # Need this to get version number from last tag
           fetch-depth: 0

{mx_bluesky-1.5.15 → mx_bluesky-1.6.3}/.github/workflows/_dist.yml

@@ -7,15 +7,18 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           # Need this to get version number from last tag
           fetch-depth: 0
 
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
       - name: Build sdist and wheel
         run: >
           export SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct) &&
-          pipx run build
+          uvx --from build pyproject-build
 
       - name: Upload sdist and wheel as artifacts
         uses: actions/upload-artifact@v4
@@ -24,12 +27,10 @@ jobs:
           path: dist
 
       - name: Check for packaging errors
-        run: pipx run twine check --strict dist/*
+        run: uvx twine check --strict dist/*
 
       - name: Install produced wheel
-        uses: ./.github/actions/install_requirements
-        with:
-          pip-install: dist/*.whl
+        run: python -m pip install dist/*.whl
 
       - name: Test module --version works using the installed wheel
         # If more than one module in src/ replace with module name to test

{mx_bluesky-1.5.15 → mx_bluesky-1.6.3}/.github/workflows/_docs.yml

@@ -12,7 +12,7 @@ jobs:
         run: sleep 60
 
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           # Need this to get version number from last tag
           fetch-depth: 0
@@ -20,11 +20,11 @@ jobs:
       - name: Install system packages
         run: sudo apt-get install graphviz
 
-      - name: Install python packages
-        uses: ./.github/actions/install_requirements
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
 
       - name: Build docs
-        run: tox -e docs
+        run: uv run --locked tox -e docs
 
       - name: Remove environment.pickle
         run: rm build/html/.doctrees/environment.pickle

{mx_bluesky-1.5.15 → mx_bluesky-1.6.3}/.github/workflows/_helm.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Helm login to GHCR
         if: ${{ github.event_name == 'push' && github.ref_type == 'tag' }}
         run: |
-          echo ${{ secrets.GITHUB_TOKEN }} | helm registry login ghcr.io/${{ github.repository }} --username ${{ github.repository_owner }} --password-stdin
+          echo ${{ secrets.GITHUB_TOKEN }} | helm registry login ghcr.io --username DiamondLightSource --password-stdin
 
       - name: Get version from Git tag
         id: meta

{mx_bluesky-1.5.15 → mx_bluesky-1.6.3}/.github/workflows/_pypi.yml

@@ -8,7 +8,7 @@ jobs:
 
     steps:
       - name: Download dist artifact
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v5
         with:
           name: dist
           path: dist

{mx_bluesky-1.5.15 → mx_bluesky-1.6.3}/.github/workflows/_release.yml

@@ -7,7 +7,7 @@ jobs:
 
     steps:
       - name: Download artifacts
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v5
         with:
           merge-multiple: true
 
@@ -23,7 +23,7 @@ jobs:
       - name: Create GitHub Release
         # We pin to the SHA, not the tag, for security reasons.
         # https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
-        uses: softprops/action-gh-release@da05d552573ad5aba039eaac05058a918a7bf631 # v2.2.2
+        uses: softprops/action-gh-release@6da8fa9354ddfdc4aeace5fc48d7f679b5214090 # v2.4.1
         with:
           prerelease: ${{ contains(github.ref_name, 'a') || contains(github.ref_name, 'b') || contains(github.ref_name, 'rc') }}
           files: "*"

mx_bluesky-1.6.3/.github/workflows/_test.yml

@@ -0,0 +1,45 @@
+on:
+  workflow_call:
+    inputs:
+      python-version:
+        type: string
+        description: The version of python to install, default is from .python-version file
+        default: ""
+      runs-on:
+        type: string
+        description: The runner to run this job on
+        required: true
+
+env:
+  # https://github.com/pytest-dev/pytest/issues/2042
+  PY_IGNORE_IMPORTMISMATCH: "1"
+  UV_PYTHON: ${{ inputs.python-version }}
+
+jobs:
+  run:
+    runs-on: ${{ inputs.runs-on }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+        with:
+          # Need this to get version number from last tag
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Run tests
+        # Longer timeout for CI due to likelihood of cold caches,
+        # cloud infra hw contention etc.
+        run: uv run --locked tox -e tests -- -m "not dlstbx" --timeout=2 --cov=mx_bluesky --cov-report term --cov-report xml:cov.xml
+
+      - name: Print dependency versions
+        if: always()
+        run: uv pip list
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          name: ${{ inputs.python-version }}/${{ inputs.runs-on }}
+          files: cov.xml

mx_bluesky-1.6.3/.github/workflows/_tox.yml

@@ -0,0 +1,28 @@
+on:
+  workflow_call:
+    inputs:
+      tox:
+        type: string
+        description: What to run under tox
+        required: true
+      skip_hooks:
+        description: "Comma-separated pre-commit hook IDs to skip"
+        required: false
+        type: string
+        default: "" # important so the context always exists
+
+jobs:
+  run:
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Run tox
+        env:
+          SKIP: ${{ inputs.skip_hooks }}
+        run: uv run --locked tox -e ${{ inputs.tox }}

{mx_bluesky-1.5.15 → mx_bluesky-1.6.3}/.github/workflows/ci.yml

@@ -5,11 +5,10 @@ on:
     branches:
       - main
     tags:
-      - '*'
+      - "*"
   pull_request:
 
 jobs:
-
   require-label:
     if: github.event_name == 'pull_request'
     uses: ./.github/workflows/_label.yml
@@ -18,23 +17,18 @@ jobs:
     uses: ./.github/workflows/_tox.yml
     with:
       tox: pre-commit,type-checking
+      skip_hooks: local-install-dodal
 
   test:
     strategy:
       matrix:
         runs-on: ["ubuntu-latest"] # can add windows-latest, macos-latest
         python-version: ["3.11", "3.12", "3.13"]
-        include:
-          # Include one that runs in the dev environment
-          - runs-on: "ubuntu-latest"
-            python-version: "dev"
       fail-fast: false
     uses: ./.github/workflows/_test.yml
     with:
       runs-on: ${{ matrix.runs-on }}
       python-version: ${{ matrix.python-version }}
-    secrets:
-      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
   container:
     needs: test
@@ -65,18 +59,19 @@ jobs:
 
   docs:
     uses: ./.github/workflows/_docs.yml
-
+    permissions:
+      contents: write
 
   dist:
     uses: ./.github/workflows/_dist.yml
-  
+
   pypi:
     needs: [dist, test]
     if: github.ref_type == 'tag'
     uses: ./.github/workflows/_pypi.yml
     permissions:
       id-token: write
-  
+
   release:
     needs: [dist, test, docs]
     if: github.ref_type == 'tag'

{mx_bluesky-1.5.15 → mx_bluesky-1.6.3}/.github/workflows/periodic.yml

@@ -10,4 +10,4 @@ jobs:
   linkcheck:
     uses: ./.github/workflows/_tox.yml
     with:
-      tox: docs build -- -b linkcheck
+      tox: docs -- -b linkcheck

mx_bluesky-1.6.3/.gitleaks.toml

@@ -0,0 +1,19 @@
+# This allow-list is limited to YAML/YML files to cut down SealedSecrets false positives.
+# All gitleaks default rules still apply everywhere (useDefault = true).
+# To broaden this allow-list to all files, comment out the 'paths' line below.
+
+[extend]
+useDefault = true
+
+[[rules]]
+id = "generic-api-key"
+
+# Pattern-only allowlist for long Ag… tokens in YAML 
+[[rules.allowlists]]
+condition = "AND"
+regexes = [
+  # Boundary-safe Ag… token without lookarounds (RE2-safe)
+  '''(?:^|[^A-Za-z0-9+/=])(Ag[A-Za-z0-9+/]{500,}={0,2})(?:[^A-Za-z0-9+/=]|$)'''
+]
+# Limit to YAML only for now. Comment this out if you want it to apply everywhere.
+paths = ['''(?i).*\.ya?ml$''']

{mx_bluesky-1.5.15 → mx_bluesky-1.6.3}/.pre-commit-config.yaml

@@ -4,6 +4,7 @@ repos:
     hooks:
       - id: check-added-large-files
         args: ["--maxkb=500"]
+        exclude: ^uv.lock
       - id: check-yaml
         args: ["--allow-multiple-documents"]
         exclude: ^helm/
@@ -34,11 +35,36 @@ repos:
         types: [python]
         require_serial: false
 
+      - id: lock dodal
+        name: keep dodal up to date in lockfile
+        pass_filenames: false
+        language: system
+        entry: uv lock --upgrade-package dls-dodal
+
+      - id: uv-sync
+        name: update uv.lock and venv
+        pass_filenames: false
+        language: system
+        entry: uv sync
+        files: ^(uv\.lock|pyproject\.toml)$
+
+      - id: local-install-dodal
+        name: editable install of dodal
+        language: system
+        pass_filenames: false
+        entry: uv pip install -e ../dodal
+        files: ^(uv\.lock|pyproject\.toml)$
+
   # Type checking
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.4.1
+    rev: v1.19.1
     hooks:
       - id: mypy
         files: 'src/.*\.py$'
         additional_dependencies: [types-requests, types-redis, pydantic]
         args: ["--ignore-missing-imports", "--no-strict-optional"]
+
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.28.0
+    hooks:
+      - id: gitleaks

mx_bluesky-1.6.3/Dockerfile

@@ -0,0 +1,71 @@
+# The devcontainer should use the developer target and run as root with podman
+# or docker with user namespaces.
+FROM ghcr.io/diamondlightsource/ubuntu-devcontainer:noble AS developer
+
+ENV CMAKE_POLICY_VERSION_MINIMUM=3.5
+
+# Add any system dependencies for the developer/build environment here
+RUN apt-get update -y && apt-get install -y --no-install-recommends \
+    graphviz \
+    ffmpeg \
+    libsm6 \
+    libxext6 \
+    && apt-get dist-clean
+
+# The build stage installs the context into the venv
+FROM developer AS build
+
+# Change the working directory to the `app` directory
+# and copy in the project
+WORKDIR /app
+COPY . /app
+RUN chmod o+wrX .
+
+# Tell uv sync to install python in a known location so we can copy it out later
+ENV UV_PYTHON_INSTALL_DIR=/python
+
+# Sync the project without its dev dependencies
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv sync --locked --no-editable --no-dev
+
+
+FROM build AS debug
+
+
+# Set origin to use ssh
+RUN git remote set-url origin git@github.com:DiamondLightSource/mx-bluesky.git
+
+
+# For this pod to understand finding user information from LDAP
+RUN apt update
+RUN DEBIAN_FRONTEND=noninteractive apt install libnss-ldapd -y
+RUN sed -i 's/files/ldap files/g' /etc/nsswitch.conf
+
+# Make editable and debuggable
+RUN uv pip install debugpy
+RUN uv pip install -e .
+ENV PATH=/app/.venv/bin:$PATH
+
+# Alternate entrypoint to allow devcontainer to attach
+ENTRYPOINT [ "/bin/bash", "-c", "--" ]
+CMD [ "while true; do sleep 30; done;" ]
+
+
+# The runtime stage copies the built venv into a runtime container
+FROM ubuntu:noble AS runtime
+
+# Add apt-get system dependecies for runtime here if needed
+# RUN apt-get update -y && apt-get install -y --no-install-recommends \
+#     some-library \
+#     && apt-get dist-clean
+
+# Copy the python installation from the build stage
+COPY --from=build /python /python
+
+# Copy the environment, but not the source code
+COPY --from=build /app/.venv /app/.venv
+ENV PATH=/app/.venv/bin:$PATH
+
+# change this entrypoint if it is not the same as the repo
+ENTRYPOINT ["mx-bluesky"]
+CMD ["--version"]

mx_bluesky-1.6.3/Dockerfile.blueapi

@@ -0,0 +1,24 @@
+# Before changing this BlueAPI version number, you should check that 
+# the BlueAPI pin in pyproject.toml is compatible, else the version will
+# be overridden
+FROM ghcr.io/diamondlightsource/blueapi:latest
+USER root
+
+ARG DEBIAN_FRONTEND=noninteractive
+
+# Need:
+# libgl, libglib2.0 for python cv2 dependency 
+RUN apt update -y && \
+    apt upgrade -y && \
+    apt install -y libgl1 libglib2.0-0
+
+RUN uv pip install --no-cache-dir --no-compile mx-bluesky
+
+# Create and set permissions for uv venv, root cache
+# and user cache. Allows Blueapi's setup-scratch
+# to change dependencies without permission errors
+RUN mkdir -p /app/.venv /root/.cache/uv /home/app/.cache/uv \
+    && chmod -R 777 /app/.venv /root/.cache/uv /home/app/.cache/uv
+
+
+USER ubuntu

{mx_bluesky-1.5.15 → mx_bluesky-1.6.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mx-bluesky
-Version: 1.5.15
+Version: 1.6.3
 Summary: Bluesky tools for MX Beamlines at DLS
 Author-email: Dominic Oram <dominic.oram@diamond.ac.uk>
 License:                                  Apache License
@@ -236,41 +236,13 @@ Requires-Dist: semver
 Requires-Dist: deepdiff
 Requires-Dist: matplotlib
 Requires-Dist: cachetools
+Requires-Dist: bluesky-stomp>=0.2.0
 Requires-Dist: daq-config-server>=v1.0.0-rc.2
 Requires-Dist: blueapi>=1.8.0
 Requires-Dist: ophyd>=1.10.5
 Requires-Dist: ophyd-async>=0.14.0
 Requires-Dist: bluesky>=1.14.6
-Requires-Dist: dls-dodal==1.68.0
-Provides-Extra: dev
-Requires-Dist: black; extra == "dev"
-Requires-Dist: build; extra == "dev"
-Requires-Dist: diff-cover; extra == "dev"
-Requires-Dist: GitPython; extra == "dev"
-Requires-Dist: import-linter; extra == "dev"
-Requires-Dist: ispyb; extra == "dev"
-Requires-Dist: ipython; extra == "dev"
-Requires-Dist: mypy; extra == "dev"
-Requires-Dist: myst-parser; extra == "dev"
-Requires-Dist: pipdeptree; extra == "dev"
-Requires-Dist: plantweb; extra == "dev"
-Requires-Dist: pre-commit; extra == "dev"
-Requires-Dist: pydata-sphinx-theme>=0.12; extra == "dev"
-Requires-Dist: pyright==1.1.406; extra == "dev"
-Requires-Dist: pytest-asyncio; extra == "dev"
-Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: pytest-random-order; extra == "dev"
-Requires-Dist: pytest-timeout; extra == "dev"
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: responses; extra == "dev"
-Requires-Dist: ruff; extra == "dev"
-Requires-Dist: sphinx-autobuild; extra == "dev"
-Requires-Dist: sphinx-copybutton; extra == "dev"
-Requires-Dist: sphinx-design; extra == "dev"
-Requires-Dist: tox-direct; extra == "dev"
-Requires-Dist: tox; extra == "dev"
-Requires-Dist: types-mock; extra == "dev"
-Requires-Dist: types-requests; extra == "dev"
+Requires-Dist: dls-dodal==2.0.0
 Dynamic: license-file
 
 mx-bluesky

mx_bluesky-1.6.3/collection_info.json

@@ -0,0 +1 @@
+{"wavelength_in_a": null, "energy_kev": null, "angular_increment_deg": 0.1, "detector_distance_mm": null}

{mx_bluesky-1.5.15 → mx_bluesky-1.6.3}/docs/developer/general/tutorials/profile-tests.rst

@@ -48,7 +48,7 @@ e.g.
 
 .. code-block:: bash
 
-    pip install pytest-profiling
+    uv pip install pytest-profiling
     pytest --profile tests/unit_tests/hyperion/external_interaction/test_write_rotation_nexus.py::test_given_detector_bit_depth_changes_then_vds_datatype_as_expected
 
 
@@ -59,7 +59,7 @@ To browse these files you need something useful. Snakeviz is a tool that can be
 .. code-block:: bash
 
     cd prof
-    pip install snakeviz
+    uv pip install snakeviz
     snakeviz combined.prof
 
 An alternative tool is py-spy.
@@ -68,7 +68,7 @@ e.g.
 
 .. code-block:: bash
 
-    pip install py-spy
+    uv add --frozen py-spy
     py-spy record -o profile.svg -- pytest -s tests/unit_tests/hyperion/experiment_plans/test_robot_load_then_centre.py::test_given_no_energy_supplied_when_robot_load_then_centre_current_energy_set_on_eiger
 
 This will generator an interactive SVG flamechart that can be opened in a browser to see hot methods.

mx_bluesky-1.6.3/docs/developer/hyperion/hyperion-blueapi.rst

@@ -0,0 +1,65 @@
+Hyperion on BlueAPI
+===================
+
+This document describes the migration of Hyperion from a monolithic service that contains its own application server 
+and is only partially dependent on BlueAPI, 
+to a standard BlueAPI application deployment. 
+
+Architecture
+------------
+
+Hyperion on BlueAPI consists of two components:
+
+* hyperion-blueapi: This is intended to ultimately be a standard blueapi installation, consisting of a beamline 
+  module and a dodal plan module. In the interim, deployment may vary from the standard method until such time as 
+  monolithic operation can be desupported. ``hyperion-blueapi`` exposes a minimal set of bluesky plans for UDC data 
+  collection.
+
+* hyperion-supervisor: This will be a separate service that is responsible for fetching instructions from 
+  Agamemnon, decoding them and sending corresponding requests to ``hyperion-blueapi`` for execution. The supervisor
+  also monitors the state of ``hyperion-blueapi``, manages the Hyperion baton and provides endpoints for status
+  monitoring.
+
+Deployment
+----------
+
+``hyperion-blueapi`` and ``hyperion-supervisor`` are automatically available in a standard Hyperion deployment.
+
+Launching
+---------
+
+``hyperion-blueapi`` can be launched in using the ``run_hyperion.sh`` script, using the ``--blueapi`` option:
+
+::
+
+    ./run_hyperion.sh --beamline=i03 --dev --blueapi
+
+
+``hyperion-supervisor`` can be launched using the ``run_hyperion.sh`` script, using the ``--supervisor`` option:
+
+::
+
+    ./run_hyperion.sh --beamline=i03 --dev --supervisor
+
+Configuration
+-------------
+
+Configuration of ``hyperion-blueapi`` and ``hyperion-supervisor`` is done via standard BlueAPI .yaml configuration files.
+Basic configuration files for i03 are supplied as follows in ``src/mx_bluesky/hyperion``.
+
+.. csv-table:: hyperion-blueapi configuration files
+    :widths: auto
+    :header: "File", "Description"
+
+    "blueapi_config.yaml", "Defines beamline device module and blueapi plans to be exported, BlueAPI REST to listen on, Stomp and graylog servers."
+
+
+.. csv-table:: hyperion-supervisor configuration files
+    :widths: auto
+    :header: "File", "Description"
+
+    "supervisor/client_config.yaml", "Tells the supervisor how to communicate with hyperion-blueapi, specifying the REST endpoint and stomp server."
+    "supervisor/supervisor_config.yaml", "Configures the internal blueapi context with a minimal beamline module containing the baton device and the graylog endpoint."
+
+When these are  deployed in kubernetes it is anticipated that these will be provided by specifying
+directly in the values.yaml which will be expanded by the base helmcharts at deployment time.

{mx_bluesky-1.5.15 → mx_bluesky-1.6.3}/docs/developer/hyperion/index.rst

@@ -17,6 +17,7 @@ Documentation specific for the Hyperion module within MX-Bluesky
             reference/param-hierarchy
             reference/coordinate-systems
             system-tests
+            hyperion-blueapi
 
         +++