Merge branch 'v1.0-rc' into dev

Author: kzscisoft

simvue/run.py

@@ -85,13 +85,18 @@ class Run:
     """
 
     @pydantic.validate_call
-    def __init__(self, mode: typing.Literal["online", "offline"] = "online") -> None:
+    def __init__(
+        self, mode: typing.Literal["online", "offline", "disabled"] = "online"
+    ) -> None:
         """Initialise a new Simvue run
 
         Parameters
         ----------
-        mode : Literal['online', 'offline'], optional
-            mode of running, by default "online"
+        mode : Literal['online', 'offline', 'disabled'], optional
+            mode of running
+                online - objects sent directly to Simvue server
+                offline - everything is written to disk for later dispatch
+                disabled - disable monitoring completely
         """
         self._uuid: str = f"{uuid.uuid4()}"
         self._mode: typing.Literal["online", "offline", "disabled"] = mode