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
Metadata
Release files for bec-lib 1.23.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| bec_lib-1.23.0.tar.gz | 102.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| bec_lib-1.23.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 219.8 kB
Release files / bec_lib-1.23.0.tar.gz
| Download URL | bec_lib-1.23.0.tar.gz |
|---|---|
| Size | 102.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c13aa80d261f40481fa50e4601a4e067c60008461201ae89115369e78ac637c8
|
|
BLAKE2b-256 checksum How to use checksums |
af11a8077b97ac8b0ce7992e301b05a31d198faa68ab77a91cff4575b1653e64
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.8.0 pkginfo/1.10.0 readme-renderer/43.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.2.1 tqdm/4.66.2 importlib-metadata/7.1.0 keyring/25.1.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.14
|
Release files / bec_lib-1.23.0-py3-none-any.whl
| Download URL | bec_lib-1.23.0-py3-none-any.whl |
|---|---|
| Size | 117.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
538d519b594b3c439f95794435a815282241d3c16911480c48d398c4445baec0
|
|
BLAKE2b-256 checksum How to use checksums |
1a7c0279d65d94a39505c44f39454196a66504f7fa3d706983186244b1da26e8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.8.0 pkginfo/1.10.0 readme-renderer/43.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.2.1 tqdm/4.66.2 importlib-metadata/7.1.0 keyring/25.1.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.14
|
