From dbd51eb2c19a283517944257a6a8cf02a8825589 Mon Sep 17 00:00:00 2001 From: "matth@ultra" Date: Wed, 12 Mar 2025 16:35:53 +0100 Subject: [PATCH] update readme --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 29b65d2..586302e 100644 --- a/README.md +++ b/README.md @@ -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**