update readme

This commit is contained in:
matth@ultra 2025-03-12 16:35:53 +01:00
parent 16e688d66f
commit dbd51eb2c1

View File

@ -1,15 +1,19 @@
# CPDCTRL
A interactive command-line utility for measuring CPD (contact potential difference).
A python library and interactive command-line utility for measuring CPD (contact potential difference).
To run it, launch **Powershell**, activate the python virtual environment and then run the script with `ipython`
To run the interactive utility, launch **Powershell**, activate the python virtual environment and then run the script with `ipython`
```ps1
cd cpdctrl
.\venv\Scripts\Activate.ps1
ipython -i .\cpdctrl\cpdctrl\cpdctrl-interactive.py
```
## Devices
Currently requires
- *Keithley 2700 SMU* for measuring the voltage (CPD)
- *Arduino Nano* connected to a *Thorlabs LEDD1B* for controlling the light source (LED)
In the ipython shell, run `help()` to get a list of available functions and help topics.
## Devices
Voltage Measurement:
- **Keithley 2700 SMU** for measuring the voltage (CPD)
Led Controller:
- **Arduino Nano** connected to a **Thorlabs LEDD1B** for controlling the light source (LED)
- **Thorlabs DC2200**