Skip to main content

BEC library

Project description

BEC Lib

bec-lib is a Python library communicating with the Beamline and Experiment Control (BEC) server. It is primarily used to build new BEC clients such as graphical user interfaces (GUIs) or command line interfaces (CLIs).

Installation

Use the package manager pip to install bec-lib.

pip install bec-lib

Documentation

The documentation is part of the BEC documentation and can be found here.

Usage

from bec_lib import BECClient

# Create a new BECClient instance and start it
bec = BECClient()
bec.start()

# Convenient access to scans and devices
scans = bec.scans
dev = bec.device_manager.devices

# define a dummy callback function
def dummy_callback(data, metadata):
    print(data, metadata)

# add the callback and subscribe to the scan segments
bec.callbacks.register(event_type="scan_segment", callback=dummy_callback, sync=False)

Contributing

Merge requests are very welcome! For major changes, please open an issue first to discuss what you would like to change. All commits should use the Angular commit scheme:

<type>(<scope>): <short summary>
  │       │             │
  │       │             └─⫸ Summary in present tense. Not capitalized. No period at the end.
  │       │
  │       └─⫸ Commit Scope: animations|bazel|benchpress|common|compiler|compiler-cli|core|
  │                          elements|forms|http|language-service|localize|platform-browser|
  │                          platform-browser-dynamic|platform-server|router|service-worker|
  │                          upgrade|zone.js|packaging|changelog|docs-infra|migrations|ngcc|ve|
  │                          devtools
  │
  └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test

The <type> and <summary> fields are mandatory, the (<scope>) field is optional.

Type

Must be one of the following:

  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci: Changes to our CI configuration files and scripts (examples: CircleCi, SauceLabs)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • test: Adding missing tests or correcting existing tests

Please make sure to update tests as necessary.

License

BSD-3-Clause

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bec_lib-0.57.1.tar.gz (85.5 kB view details)

Uploaded Source

Built Distribution

bec_lib-0.57.1-py3-none-any.whl (97.9 kB view details)

Uploaded Python 3

File details

Details for the file bec_lib-0.57.1.tar.gz.

File metadata

  • Download URL: bec_lib-0.57.1.tar.gz
  • Upload date:
  • Size: 85.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/42.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.1.0 tqdm/4.66.1 importlib-metadata/7.0.1 keyring/24.3.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.9.18

File hashes

Hashes for bec_lib-0.57.1.tar.gz
Algorithm Hash digest
SHA256 98fdc7c0aff80e716ccc515fbe5de9d1b09f88a5e92fd6ed87d514c1a249669b
MD5 b54ae8f04f0e07d7beaa366f28c25305
BLAKE2b-256 19cb372ae48c7da60e3ea62be1940095a7423e05347a5ba7e7f1ac5858d8594a

See more details on using hashes here.

File details

Details for the file bec_lib-0.57.1-py3-none-any.whl.

File metadata

  • Download URL: bec_lib-0.57.1-py3-none-any.whl
  • Upload date:
  • Size: 97.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/42.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.1.0 tqdm/4.66.1 importlib-metadata/7.0.1 keyring/24.3.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.9.18

File hashes

Hashes for bec_lib-0.57.1-py3-none-any.whl
Algorithm Hash digest
SHA256 62a86f8e51d7065c98a2cb721342901fa67189f7e71e45f15965fa1f78010672
MD5 95cc9364a826eb3ab4b579eb5a9f6411
BLAKE2b-256 ea377274cb5a8994b82b1d5a16cacad5ab225cb5febf746b990d0aaa7e0119c4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page