Skip to content

Commit 3e0923c

Browse files
gilesknapgilesknap
committed
add some stub pages
1 parent 84f44bb commit 3e0923c

File tree

4 files changed

+162
-0
lines changed

4 files changed

+162
-0
lines changed

‎docs/user/how-to/builder2ibek.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Builder2ibek Conversion Tool
2+
============================
3+
4+
.. warning::
5+
6+
This page is only relevant to DLS users who are converting an xml
7+
builder beamline to epics-containers. i.e. those whose beamlines
8+
have a BLxxY-BUILDER project.
9+
10+
TODO: this page is WIP and will be updated by Feb 2024.
11+
12+
``builder2ibek`` is a tool to convert DLS builder XML to ibek instance YAML.
13+
It is for working with converting IOC instances to epics-containers.
14+
15+
At present (until a new python app distribution mechanism is in place) it
16+
is installed at DLS in the following location:
17+
18+
``/dls_sw/work/python3/ec-venv/bin/builder2ibek``

‎docs/user/how-to/builder2ibek.support.rst

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
Builder2ibek.support Conversion Tool
2+
====================================
3+
4+
.. warning::
5+
6+
This page is only relevant to DLS users who are converting
7+
a DLS support module with builder support into an epics-containers
8+
Generic IOC. i.e. support modules that have an ``etc/builder.py`` file.
9+
10+
TODO: this page is WIP and will be updated by Feb 2024.
11+
12+
``builder2ibek.support`` is a tool to convert DLS builder support modules
13+
into ibek support YAML for the ``ibek-support`` repository.
14+
15+
16+
builder2ibek.support example
17+
----------------------------
18+
19+
.. code:: bash
20+
21+
./builder2ibek.support.py /dls_sw/prod/R3.14.12.7/support/lakeshore340/2-6 ioc-lakeshore340/ibek-support/lakeshore340/lakeshore340.yaml
22+
23+
24+
.. code-block:: xml
25+
26+
<?xml version="1.0" ?>
27+
<components arch="linux-x86_64">
28+
<devIocStats.devIocStatsHelper ioc="BL16I-EA-IOC-07" name="STATS"/>
29+
<asyn.AsynIP name="p1" port="127.0.0.1:5400"/>
30+
<lakeshore340.lakeshore340 ADDR="12" LOOP="1" P="BL16I-EA-LS340-01" PORT="p1" SCAN="5" TEMPSCAN="1" gda_desc="Lakeshore 340 Temperature Controller" gda_name="LS340b" name="lakeshore"/>
31+
<EPICS_BASE.dbpf name="d1" pv="BL16I-EA-LS340-01:DISABLE" value="1"/>
32+
</components>
33+
34+
35+
.. code:: yaml
36+
37+
# yaml-language-server: $schema=https://github.com/epics-containers/ibek/releases/download/1.2.0/ibek.support.schema.json
38+
39+
module: lakeshore340
40+
41+
defs:
42+
43+
- name: lakeshore340
44+
description: |-
45+
Lakeshore 340 Temperature Controller
46+
Notes: The temperatures in Kelvin are archived once every 10 secs.
47+
args:
48+
49+
- type: str
50+
name: P
51+
description: |-
52+
Prefix for PV name
53+
54+
- type: str
55+
name: PORT
56+
description: |-
57+
Bus/Port Address (eg. ASYN Port).
58+
59+
- type: str
60+
name: ADDR
61+
description: |-
62+
Address on the bus
63+
64+
- type: str
65+
name: SCAN
66+
description: |-
67+
SCAN rate for non-temperature/voltage parameters.
68+
69+
- type: str
70+
name: TEMPSCAN
71+
description: |-
72+
SCAN rate for the temperature/voltage readings
73+
74+
- type: id
75+
name: name
76+
description: |-
77+
Object and gui association name
78+
79+
- type: str
80+
name: gda_name
81+
description: |-
82+
Name in gda interface file (Default = )
83+
84+
- type: str
85+
name: gda_desc
86+
description: |-
87+
Description in gda interface file (Default = )
88+
89+
- type: int
90+
name: LOOP
91+
description: |-
92+
Which heater PID loop to control (Default = 1)
93+
default: 1
94+
95+
databases:
96+
97+
- file: $(LAKESHORE340)/db/lakeshore340.template
98+
args:
99+
name:
100+
SCAN:
101+
gda_name:
102+
P:
103+
TEMPSCAN:
104+
gda_desc:
105+
PORT:
106+
LOOP:
107+
ADDR:
108+

‎docs/user/index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ side-bar.
4646
how-to/own_tools
4747
how-to/useful_k8s
4848
how-to/ibek-support
49+
how-to/builder2ibek
50+
how-to/builder2ibek.support
4951

5052
+++
5153

@@ -79,6 +81,7 @@ side-bar.
7981
reference/cli
8082
reference/ioc_helm_chart
8183
reference/k8s_resources
84+
reference/vscode_settings
8285

8386
+++
8487

‎docs/user/reference/vscode_settings.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Recommended VSCode Settings
2+
===========================
3+
4+
I've picked a handful of my user settings which I think are useful for most
5+
people working on epics-containers.
6+
7+
TODO: write up a description of why these are useful. Particularly with
8+
regards to auto discovery of git repos.
9+
10+
.. code-block::
11+
12+
scm.repositories.visible: 10
13+
git.repositoryScanMaxDepth: 0
14+
git.openRepositoryInParentFolders: never
15+
files.trimTrailingWhitespace: true
16+
terminal.integrated.scrollback: 20000
17+
dev.containers.defaultExtensions: [
18+
"samuelcolvin.jinjahtml",
19+
"moshfeu.compare-folders",
20+
"GitHub.copilot",
21+
"charliermarsh.ruff",
22+
"Gruntfuggly.todo-tree",
23+
"streetsidesoftware.code-spell-checker",
24+
"eamodio.gitlens",
25+
"tamasfe.even-better-toml",
26+
"redhat.vscode-yaml",
27+
"ryanluker.vscode-coverage-gutters",
28+
"mhutchie.git-graph",
29+
"ms-vscode.makefile-tools"
30+
],
31+
"[yaml]": {
32+
"editor.defaultFormatter": "redhat.vscode-yaml"
33+
},

0 commit comments

Comments
 (0)