System Monitor

The System Monitor is a a Juice dashboard designed to monitor and manage your setup’s infrastructure—especially cryogenic equipment. It ensures that your instruments operate within safe and optimal conditions.

Core Components

The following components, installed by default with OrangeQS Juice, provide system monitoring capabilities

1. Client APIs A set of APIs that allow operators to interact with instruments in your setup.

2. Dashboard Widgets Preconfigured widgets integrated into the Juice dashboard provide a graphical interface for monitoring and interacting with your equipment via the client APIs.

You can install backends for your cryostat of choice by installing extension packages provided by OrangeQS or write your own backend using the communication standards defined by OrangeQS Juice, which will then be picked up automatically by Juice.

OrangeQS Juice ships with a mock backend by default, which you can set up by doing the following

1. Create a new service and use the provided initialization module. You can do this by adding the following snippet to your orchestration.toml, then running juice install --restart --rebuild:

   [services.system-monitor]
   entrypoint = "orangeqs.juice.system_monitor._service:SystemMonitorService"
   
   [services.system-monitor.init_kwargs]
   init_module = "orangeqs.juice.system_monitor._mock_entrypoint"
   
   [influxdb2.buckets.system_monitor]
   name = "system_monitor"
   

2. You can then configure your mock system monitor service using the configurations provided in mock-system-monitor.toml.