improve controller.yaml - get demo working

Author: gilesknap

.gitignore

@@ -70,3 +70,6 @@ lockfiles/
 # ruff cache
 .ruff_cache/
 *code-workspace
+
+# auto-generated files
+opi/auto-generated/*.bob

README.md

@@ -7,27 +7,23 @@
 
 An example simulation IOC for testing fastCS
 
-This is where you should write a short paragraph that describes what your module does,
-how it does it, and why people should use it.
 
 Source          | <https://github.com/DiamondLightSource/fastcs-example>
 :---:           | :---:
-PyPI            | `pip install fastcs-example`
+PyPI            | `pip install fastcs-example[demo]`
 Docker          | `docker run ghcr.io/diamondlightsource/fastcs-example:latest`
 Releases        | <https://github.com/DiamondLightSource/fastcs-example/releases>
 
-This is where you should put some images or code snippets that illustrate
-some relevant examples. If it is a library then you might put some
-introductory code here:
+# Usage
 
-```python
-from fastcs_example import __version__
+Start the simulation temperature controller by running the following command:
 
-print(f"Hello fastcs_example {__version__}")
+```bash
+tickit all src/fastcs_example/simulation/temp_controller.yaml
 ```
 
-Or if it is a commandline tool then you might put some example commands here:
+Start the fastCS IOC by running the following command:
 
-```
-python -m fastcs_example --version
+```bash
+fastcs-example run src/fastcs_example/controller.yaml
 ```

opi/auto-generated/.placeholder

@@ -31,10 +31,13 @@ dev = [
     "ruff",
     "tox-direct",
     "types-mock",
+    "tickit~=0.4.3",
 ]
+demo = ["tickit~=0.4.3"]
 
 [project.scripts]
 fastcs-example = "fastcs_example.__main__:main"
+fastcs-demo = "fastcs.demo.__main__:main"
 
 [project.urls]
 GitHub = "https://github.com/DiamondLightSource/fastcs-example"

pyproject.toml

@@ -3,14 +3,13 @@ controller:
   ip_settings:
     ip: "localhost"
     port: 25565
-  num_ramp_controllers: 4
+  num_ramp_controllers: 1
 transport:
-  - gql:
-      host: localhost
-      port: 8083
-      log_level: info
+  - pva_ioc:
+      pv_prefix: DEMO
+    gui:
+      output_path: opi/auto-generated/pva_example.bob
   - ca_ioc:
       pv_prefix: DEMO
     gui:
-      title: Temperature Controller Demo
-      output_path: ./demo.bob
+      output_path: opi/auto-generated/ca_example.bob