Skip to content

Commit d360a62

Browse files
committed
Additional docs, fix import
1 parent f3d3938 commit d360a62

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

docs/developer/hyperion/hyperion-blueapi.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,26 @@ Launching
4040
::
4141

4242
./run_hyperion.sh --beamline=i03 --dev --supervisor
43+
44+
Configuration
45+
-------------
46+
47+
Configuration of ``hyperion-blueapi`` and ``hyperion-supervisor`` is done via standard BlueAPI .yaml configuration files.
48+
Basic configuration files for i03 are supplied as follows in ``src/mx_bluesky/hyperion``.
49+
50+
.. csv-table:: hyperion-blueapi configuration files
51+
:widths: auto
52+
:header: "File", "Description"
53+
54+
"blueapi_config.yaml", "Defines beamline device module and blueapi plans to be exported, BlueAPI REST to listen on, Stomp and graylog servers."
55+
56+
57+
.. csv-table:: hyperion-supervisor configuration files
58+
:widths: auto
59+
:header: "File", "Description"
60+
61+
"supervisor/client_config.yaml", "Tells the supervisor how to communicate with hyperion-blueapi, specifying the REST endpoint and stomp server."
62+
"supervisor/supervisor_config.yaml", "Configures the internal blueapi context with a minimal beamline module containing the baton device and the graylog endpoint."
63+
64+
When these are deployed in kubernetes it is anticipated that these will be provided by specifying
65+
directly in the values.yaml which will be expanded by the base helmcharts at deployment time.

tests/system_tests/hyperion/supervisor/test_supervisor.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@
2121
from mx_bluesky.hyperion.parameters.components import UDCCleanup
2222
from mx_bluesky.hyperion.plan_runner import PlanError
2323
from mx_bluesky.hyperion.supervisor import SupervisorRunner
24-
from unit_tests.hyperion.external_interaction.callbacks.test_alert_on_container_change import (
24+
25+
from ....unit_tests.hyperion.external_interaction.callbacks.test_alert_on_container_change import (
2526
TEST_VISIT,
2627
)
2728

0 commit comments

Comments
 (0)