Skip to main content

CI Coverage PyPI License

techui_builder

A package for building Phoebus GUIs

Techui-builder is a module for building and organising phoebus gui screens using a builder-ibek yaml description of an IOC, with a user created techui.yaml file containing a description of the screens the user wants to create.

What Where
Source https://github.com/DiamondLightSource/techui-builder
PyPI pip install techui-builder
Releases https://github.com/DiamondLightSource/techui-builder/releases

The process to use this module goes as follows (WIP):

Requirements

  1. Docker
  2. VSCode
  3. CS-Studio (Phoebus)

Installation

  1. Clone this module with the --recursive flag to pull in techui-support for the associated bob files.
  2. Open the project using VSCode.
  3. Reopen the project in a container. Make sure you are using the VSCode extension: Dev Containers by Microsoft.

Setting Up

  1. Clone the beamline ixx-services repo to the root of this project, ensuring each IOC service has been converted to the ibek format.

    git clone --recursive git@gitlab.diamond.ac.uk:controls/containers/beamline/ixx-services.git

  2. Create your handmade synoptic overview screen in Phoebus and place at ixx-services/synoptic/index.bob.

  3. Construct a techui.yaml file inside ixx-services/synoptic containing all the components from the services:

    beamline:
        location: {e.g. b23, b01-1}
        domain: {e.g. bl23b}
        desc: {beamline description}
        url: {e.g. b23-opis.diamond.ac.uk}
    
    components:
        {component name}:
            desc: {component description}
            prefix: {PV prefix}
            extras: 
                - {extra prefix 1}
                - {extra prefix 2}
    
  4. Run this command to locally generate a schema, which can be used for validation testing

    $ techui-builder schema

    Add the following at the top of the techui.yaml to validate it against a schema

    # yaml-language-server: $schema=/path/to/techui.schema.yml

    where the path can be the dev container workspace, or a released asset in the GitHub repo.

Generating the Synoptic

$ techui-builder build /path/to/synoptic/techui.yaml

This populates index.bob and individual component screens inside ixx-services/synoptic.

Generating the JsonMap

$ techui-builder generate-jsonmap /path/to/synoptic/index.bob

This populates JsonMap.json with the tree of component screens inside ixx-services/synoptic/index.bob.

Generating the Status PV database file

$ techui-builder status /path/to/synoptic/techui.yaml

This populates config/status.db with the status PVs of components inside ixx-services/synoptic/techui.yaml.

Viewing the Synoptic

In a terminal outside of the container:

$ module load phoebus
$ phoebus.sh -resource /path/to/opis/index.bob

Metadata

Release files for techui-builder 0.8.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for techui-builder 0.8.2
File Size Uploaded Provenance Actions
techui_builder-0.8.2.tar.gz 1.1 MB Without provenance Details for techui_builder-0.8.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for techui-builder 0.8.2
File Interpreter ABI Platform Actions
techui_builder-0.8.2-py3-none-any.whl Python 3 none any Details for techui_builder-0.8.2-py3-none-any.whl

Total release size: 1.1 MB

Release files / techui_builder-0.8.2.tar.gz

Download URL techui_builder-0.8.2.tar.gz
Size 1.1 MB
Tags Source
SHA-256 checksum
How to use checksums
344861d43bf09c91ec5b255d27d8fe3b01f54b90e466bdc6d26edd838605be67
BLAKE2b-256 checksum
How to use checksums
17a04e9b4e856dd83772ba28d14de01aaf87a581a07fdc9b64ee9d27cc5527e9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / techui_builder-0.8.2-py3-none-any.whl

Download URL techui_builder-0.8.2-py3-none-any.whl
Size 37.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9770736304ae8ca3ef925f3f8f2d20d3c8d57e1988a5911e5d0984d41c2357d7
BLAKE2b-256 checksum
How to use checksums
471f14f985be073738c721276b458dbe606781e40d6ce7b3613787ec4081e647
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Security for techui-builder 0.8.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.8.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page