Kernel test bench controls
This repo aim to provide a full set of tools to control all the devices on the Kernel-Nuller test bench.
🚀 Quickstart
Requirements:
- Python 3.12
- Conda (recommended)
Option 1: Installation with Conda (recommended)
-
Create and activate the conda environment
conda env create -f environment.yml conda activate photonics
-
Start a Python instance
python
And import the kbench module
import kbench
Option 2: Installation with pip
-
(Recommended) Create a virtual environment
python3.12 -m venv .venv
and activate it
source .venv/bin/activate # Linux .venv/Scripts/activate # Windows
-
Install the Python module
pip install -r requirements.txt pip install -e .
-
Start a Python instance
python
And import the kbench module
import kbench
You can now use all Kbench devices according to the documentation!
📚 Documentation
The documentation should be available at the adress: kbench.readthedocs.io.
If you want to build the doc locally, once the project is setup (according to the instructions above):
- Go in the
docsfoldercd docs
- Install the requirements (by preference, in a virtual environment)
pip install -r requirements.txt
- Build the doc
make html # Linux .\make.bat html # Windows
Once the documentation is build, you can find it in the docs/_build_ folder.
1 maintainer
Metadata
1 maintainer
Release files for kbench-controls 0.7.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| kbench_controls-0.7.3.tar.gz | 114.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| kbench_controls-0.7.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 230.1 kB
Release files / kbench_controls-0.7.3.tar.gz
| Download URL | kbench_controls-0.7.3.tar.gz |
|---|---|
| Size | 114.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1a77be4b9f39b2dfa1f91b7fefa4b84acbd2be70b1afc0c4c83c77766f0e6d5c
|
|
BLAKE2b-256 checksum How to use checksums |
0d8228aced257caf889c7dbeac80e7b354e9f0a053dd3a0ccf7d1d9b72a771b2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.11
|
Release files / kbench_controls-0.7.3-py3-none-any.whl
| Download URL | kbench_controls-0.7.3-py3-none-any.whl |
|---|---|
| Size | 115.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ed0d3c0cc6ab84a5fe8ba3cc394acde3dee90ed4ecb43c7f1b8e0c36fc23989e
|
|
BLAKE2b-256 checksum How to use checksums |
e6aea25cb078821f3b9e18fc959fc151d8577843c09a1a76dd562c9f35a10d8b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.11
|
