Skip to content

Commit

Permalink
deploy: 123111d
Browse files Browse the repository at this point in the history
  • Loading branch information
gilesknap committed Oct 30, 2023
1 parent aeffbf3 commit 52b488c
Show file tree
Hide file tree
Showing 56 changed files with 125 additions and 125 deletions.
2 changes: 1 addition & 1 deletion dev/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 1dd8943378dd6a2b9baab7278f79b539
config: ec1c039b1513cdf46583c4b21bad0246
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified dev/.doctrees/environment.pickle
Binary file not shown.
Binary file modified dev/.doctrees/user/tutorials/create_ioc.doctree
Binary file not shown.
Binary file modified dev/.doctrees/user/tutorials/dev_container.doctree
Binary file not shown.
Binary file modified dev/.doctrees/user/tutorials/setup_workstation.doctree
Binary file not shown.
22 changes: 11 additions & 11 deletions dev/_sources/user/tutorials/create_ioc.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ This should launch vscode and open the values.yaml file. Add the following:

.. code-block:: yaml
image: ghcr.io/epics-containers/ioc-adsimdetector-linux-runtime:2023.10.6b1
image: ghcr.io/epics-containers/ioc-adsimdetector-linux-runtime:2023.10.7
This tells the IOC Instance to run in the ``ioc-adsimdetector-linux-runtime``
container. This container was built by the Generic IOC source repo here
Expand Down Expand Up @@ -180,7 +180,7 @@ detector as follows:

.. code:: yaml
# yaml-language-server: $schema=https://github.com/epics-containers/ioc-adsimdetector/releases/download/2023.10.6b1/ibek.ioc.schema.json
# yaml-language-server: $schema=https://github.com/epics-containers/ioc-adsimdetector/releases/download/2023.10.7/ibek.ioc.schema.json
ioc_name: bl01t-ea-ioc-02
description: Example simulated camera for BL01T
Expand All @@ -189,7 +189,7 @@ detector as follows:
- type: ADSimDetector.simDetector
PORT: DET.DET
P: BL01T-EA-TST-01
P: BL01T-EA-TST-02
R: ":DET:"
.. note::
Expand All @@ -205,7 +205,7 @@ detector as follows:


This will create us a simulation detector driver with PV prefix
``BL01T-EA-TST-01:DET:`` that publishes its output on the Asyn port ``DET.DET``.
``BL01T-EA-TST-02:DET:`` that publishes its output on the Asyn port ``DET.DET``.

Note that the Generic IOC includes all of the support modules that are dependencies
of ``ADSimDetector`` and each of those contributes its own set of definitions in its
Expand All @@ -216,13 +216,13 @@ it to our simulation detector by adding this to our *IOC yaml* file:
- type: ADCore.NDPvaPlugin
PORT: DET.PVA
PVNAME: BL01T-EA-TST-01:PVA:OUTPUT
P: BL01T-EA-TST-01
PVNAME: BL01T-EA-TST-02:PVA:OUTPUT
P: BL01T-EA-TST-02
R: ":PVA:"
NDARRAY_PORT: DET.DET
This adds a PVA plugin to the IOC that will publish the output of the simulation
detector over a PVAccess channel called ``BL01T-EA-TST-01:PVA:OUTPUT``. The
detector over a PVAccess channel called ``BL01T-EA-TST-02:PVA:OUTPUT``. The
*Support yaml* that declared that plugin came from the ADCore module. This is
a dependency of ADSimDetector and so is included in the Generic IOC container.

Expand Down Expand Up @@ -273,14 +273,14 @@ and launch it to view the IOC output:
.. code-block:: bash
pip install c2dataviewer
c2dv --pv BL01T-EA-TST-01:PVA:OUTPUT &
c2dv --pv BL01T-EA-TST-02:PVA:OUTPUT &
Now we can start our simulation detector like this:

.. code-block:: bash
ec ioc exec bl01t-ea-ioc-02
caput BL01T-EA-TST-01:DET:Acquire 1
caput BL01T-EA-TST-02:DET:Acquire 1
You should see a moving image appear in the ``c2dv`` window. For smoothest
results you may want to hit ``Auto`` in the ``Image and Zoom`` section of the
Expand All @@ -307,15 +307,15 @@ That is because every Generic IOC publishes an *IOC schema* that describes
the set of entities that an instance of that IOC may instantiate.

The Generic IOC we used was released at this location:
https://github.com/epics-containers/ioc-adsimdetector/releases/tag/2023.10.6b1.
https://github.com/epics-containers/ioc-adsimdetector/releases/tag/2023.10.7.
This page includes the assets that are published as part of the release and
one of those is ``ibek.ioc.schema.json``. This is the *IOC schema* for the
``ioc-adsimdetector`` Generic IOC. This is what we referred to at the top of
our *IOC yaml* file like this:

.. code:: yaml
# yaml-language-server: $schema=https://github.com/epics-containers/ioc-adsimdetector/releases/download/2023.10.6b1/ibek.ioc.schema.json
# yaml-language-server: $schema=https://github.com/epics-containers/ioc-adsimdetector/releases/download/2023.10.7/ibek.ioc.schema.json
When editing with a YAML aware editor like VSCode this will enable auto
completion and validation of the *IOC yaml* file. To enable this in VSCode
Expand Down
2 changes: 1 addition & 1 deletion dev/_sources/user/tutorials/dev_container.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ this tutorial:
# starting from folder bl01t so that the clone is next to bl01t
cd ..
git clone --recursive [email protected]:epics-containers/ioc-adsimdetector.git -b 2023.10.6b1
git clone --recursive [email protected]:epics-containers/ioc-adsimdetector.git -b 2023.10.7
cd ioc-adsimdetector
ec dev build
Expand Down
6 changes: 3 additions & 3 deletions dev/_sources/user/tutorials/setup_workstation.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The tools you need to install are:

- Visual Studio Code
- a container platform, either podman or docker
- Python 3.9 or later + a Python virtual environment
- Python 3.10 or later + a Python virtual environment
- git client for version control

Visual Studio Code is recommended because it has excellent integration with
Expand Down Expand Up @@ -115,9 +115,9 @@ Install Python

.. Note::

**DLS Users**: RHEL 8 Workstations at DLS have Python 3.9 installed by default.
**DLS Users**: use ``module load python/3.11``

Go ahead and install Python 3.9 or later. 3.11 is recommended as this is the
Go ahead and install Python 3.10 or later. 3.11 is recommended as this is the
highest version that epics-containers has been tested with.

There are instructions for installing Python on all platforms here:
Expand Down
2 changes: 1 addition & 1 deletion dev/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '0.9.1.dev35+ge1a49e2',
VERSION: '0.9.1.dev36+g123111d',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
4 changes: 2 additions & 2 deletions dev/developer/explanations/decisions.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>Architectural Decision Records &#8212; epics-containers.github.io 0.9.1.dev35+ge1a49e2 documentation</title>
<title>Architectural Decision Records &#8212; epics-containers.github.io 0.9.1.dev36+g123111d documentation</title>



Expand Down Expand Up @@ -38,7 +38,7 @@
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
<script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>

<script src="../../_static/documentation_options.js?v=2c1bb036"></script>
<script src="../../_static/documentation_options.js?v=2476cba8"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>1. Record architecture decisions &#8212; epics-containers.github.io 0.9.1.dev35+ge1a49e2 documentation</title>
<title>1. Record architecture decisions &#8212; epics-containers.github.io 0.9.1.dev36+g123111d documentation</title>



Expand Down Expand Up @@ -38,7 +38,7 @@
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
<script src="../../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>

<script src="../../../_static/documentation_options.js?v=2c1bb036"></script>
<script src="../../../_static/documentation_options.js?v=2476cba8"></script>
<script src="../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>2. Adopt epics-containers.github.io for project structure &#8212; epics-containers.github.io 0.9.1.dev35+ge1a49e2 documentation</title>
<title>2. Adopt epics-containers.github.io for project structure &#8212; epics-containers.github.io 0.9.1.dev36+g123111d documentation</title>



Expand Down Expand Up @@ -38,7 +38,7 @@
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
<script src="../../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>

<script src="../../../_static/documentation_options.js?v=2c1bb036"></script>
<script src="../../../_static/documentation_options.js?v=2476cba8"></script>
<script src="../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
4 changes: 2 additions & 2 deletions dev/developer/how-to/build-docs.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>Build the docs using sphinx &#8212; epics-containers.github.io 0.9.1.dev35+ge1a49e2 documentation</title>
<title>Build the docs using sphinx &#8212; epics-containers.github.io 0.9.1.dev36+g123111d documentation</title>



Expand Down Expand Up @@ -38,7 +38,7 @@
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
<script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>

<script src="../../_static/documentation_options.js?v=2c1bb036"></script>
<script src="../../_static/documentation_options.js?v=2476cba8"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
4 changes: 2 additions & 2 deletions dev/developer/how-to/contribute.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>Contributing to the project &#8212; epics-containers.github.io 0.9.1.dev35+ge1a49e2 documentation</title>
<title>Contributing to the project &#8212; epics-containers.github.io 0.9.1.dev36+g123111d documentation</title>



Expand Down Expand Up @@ -38,7 +38,7 @@
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
<script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>

<script src="../../_static/documentation_options.js?v=2c1bb036"></script>
<script src="../../_static/documentation_options.js?v=2476cba8"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
4 changes: 2 additions & 2 deletions dev/developer/how-to/make-release.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>Make a release &#8212; epics-containers.github.io 0.9.1.dev35+ge1a49e2 documentation</title>
<title>Make a release &#8212; epics-containers.github.io 0.9.1.dev36+g123111d documentation</title>



Expand Down Expand Up @@ -38,7 +38,7 @@
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
<script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>

<script src="../../_static/documentation_options.js?v=2c1bb036"></script>
<script src="../../_static/documentation_options.js?v=2476cba8"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
4 changes: 2 additions & 2 deletions dev/developer/how-to/update-tools.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>Update the tools &#8212; epics-containers.github.io 0.9.1.dev35+ge1a49e2 documentation</title>
<title>Update the tools &#8212; epics-containers.github.io 0.9.1.dev36+g123111d documentation</title>



Expand Down Expand Up @@ -38,7 +38,7 @@
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
<script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>

<script src="../../_static/documentation_options.js?v=2c1bb036"></script>
<script src="../../_static/documentation_options.js?v=2476cba8"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
4 changes: 2 additions & 2 deletions dev/developer/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>Developer Guide &#8212; epics-containers.github.io 0.9.1.dev35+ge1a49e2 documentation</title>
<title>Developer Guide &#8212; epics-containers.github.io 0.9.1.dev36+g123111d documentation</title>



Expand Down Expand Up @@ -38,7 +38,7 @@
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
<script src="../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>

<script src="../_static/documentation_options.js?v=2c1bb036"></script>
<script src="../_static/documentation_options.js?v=2476cba8"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
4 changes: 2 additions & 2 deletions dev/developer/reference/standards.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>Standards &#8212; epics-containers.github.io 0.9.1.dev35+ge1a49e2 documentation</title>
<title>Standards &#8212; epics-containers.github.io 0.9.1.dev36+g123111d documentation</title>



Expand Down Expand Up @@ -38,7 +38,7 @@
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
<script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>

<script src="../../_static/documentation_options.js?v=2c1bb036"></script>
<script src="../../_static/documentation_options.js?v=2476cba8"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
4 changes: 2 additions & 2 deletions dev/developer/tutorials/dev-install.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>Developer Contributing &#8212; epics-containers.github.io 0.9.1.dev35+ge1a49e2 documentation</title>
<title>Developer Contributing &#8212; epics-containers.github.io 0.9.1.dev36+g123111d documentation</title>



Expand Down Expand Up @@ -38,7 +38,7 @@
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
<script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>

<script src="../../_static/documentation_options.js?v=2c1bb036"></script>
<script src="../../_static/documentation_options.js?v=2476cba8"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
4 changes: 2 additions & 2 deletions dev/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &#8212; epics-containers.github.io 0.9.1.dev35+ge1a49e2 documentation</title>
<title>Index &#8212; epics-containers.github.io 0.9.1.dev36+g123111d documentation</title>



Expand Down Expand Up @@ -37,7 +37,7 @@
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
<script src="_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>

<script src="_static/documentation_options.js?v=2c1bb036"></script>
<script src="_static/documentation_options.js?v=2476cba8"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
4 changes: 2 additions & 2 deletions dev/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>epics-containers &#8212; epics-containers.github.io 0.9.1.dev35+ge1a49e2 documentation</title>
<title>epics-containers &#8212; epics-containers.github.io 0.9.1.dev36+g123111d documentation</title>



Expand Down Expand Up @@ -38,7 +38,7 @@
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
<script src="_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>

<script src="_static/documentation_options.js?v=2c1bb036"></script>
<script src="_static/documentation_options.js?v=2476cba8"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
4 changes: 2 additions & 2 deletions dev/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><title>Search - epics-containers.github.io 0.9.1.dev35+ge1a49e2 documentation</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><title>Search - epics-containers.github.io 0.9.1.dev36+g123111d documentation</title>



Expand Down Expand Up @@ -36,7 +36,7 @@
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
<script src="_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>

<script src="_static/documentation_options.js?v=2c1bb036"></script>
<script src="_static/documentation_options.js?v=2476cba8"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
2 changes: 1 addition & 1 deletion dev/searchindex.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/user/explanations/docs-structure.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>About the documentation &#8212; epics-containers.github.io 0.9.1.dev35+ge1a49e2 documentation</title>
<title>About the documentation &#8212; epics-containers.github.io 0.9.1.dev36+g123111d documentation</title>



Expand Down Expand Up @@ -38,7 +38,7 @@
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=c5ced968eda925caa686" />
<script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=c5ced968eda925caa686"></script>

<script src="../../_static/documentation_options.js?v=2c1bb036"></script>
<script src="../../_static/documentation_options.js?v=2476cba8"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down
Loading

0 comments on commit 52b488c

Please sign in to comment.