kbench-controls 0.7.2

Python package for controlling optical test bench equipment in kernel-nulling interferometry

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)

1. Create and activate the conda environment

   conda env create -f environment.yml
   conda activate kbench-controls
   

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.