Skip to main content

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:

Option 1: Installation with Conda (recommended)

  1. Create and activate the conda environment

    conda env create -f environment.yml
    conda activate photonics
    
  2. Start a Python instance

    python
    

    And import the kbench module

    import kbench
    

Option 2: Installation with pip

  1. (Recommended) Create a virtual environment

    python3.12 -m venv .venv
    

    and activate it

    source .venv/bin/activate # Linux
    .venv/Scripts/activate # Windows
    
  2. Install the Python module

    pip install -r requirements.txt
    pip install -e .
    
  3. 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):

  1. Go in the docs folder
    cd docs
    
  2. Install the requirements (by preference, in a virtual environment)
    pip install -r requirements.txt
    
  3. Build the doc
    make html # Linux
    .\make.bat html # Windows
    

Once the documentation is build, you can find it in the docs/_build_ folder.

Download files

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

Source Distribution

kbench_controls-0.7.3.tar.gz (114.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kbench_controls-0.7.3-py3-none-any.whl (115.9 kB view details)

Uploaded Python 3

File details

Details for the file kbench_controls-0.7.3.tar.gz.

File metadata

  • Download URL: kbench_controls-0.7.3.tar.gz
  • Upload date:
  • Size: 114.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for kbench_controls-0.7.3.tar.gz
Algorithm Hash digest
SHA256 1a77be4b9f39b2dfa1f91b7fefa4b84acbd2be70b1afc0c4c83c77766f0e6d5c
MD5 1c97ce39c18ded2dd0093b41c1936fcd
BLAKE2b-256 0d8228aced257caf889c7dbeac80e7b354e9f0a053dd3a0ccf7d1d9b72a771b2

See more details on using hashes here.

File details

Details for the file kbench_controls-0.7.3-py3-none-any.whl.

File metadata

File hashes

Hashes for kbench_controls-0.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ed0d3c0cc6ab84a5fe8ba3cc394acde3dee90ed4ecb43c7f1b8e0c36fc23989e
MD5 75bbc72c5361693e419d75af5b438412
BLAKE2b-256 e6aea25cb078821f3b9e18fc959fc151d8577843c09a1a76dd562c9f35a10d8b

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.7.3 This release

2 files

0.7.2

2 files

0.7.1

2 files

0.7.0

2 files

0.6.6

2 files

0.6.5

2 files

0.6.4

2 files

0.6.3

2 files

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

0.5.2

2 files

0.5.1

2 files

0.4.16

2 files

0.4.15

2 files

0.4.14

2 files

0.4.13

2 files

0.4.12

2 files

0.4.11

2 files

0.4.10

2 files

0.4.0

2 files

0.3.7

2 files

0.3.6

2 files

0.3.5

2 files

0.3.4

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page