Cape-Calibration-Tool#

Main Documentation: https://orgua.github.io/shepherd

Source Code: https://github.com/orgua/shepherd

shepherd-cal is the command line utility for calibrating and profiling a shepherd cape.

Installation#

shepherd-cal is a pure python package and currently NOT available on PyPI.

For install from local sources:

cd shepherd/software/shepherd-calibration/
pip3 install ./

For install directly from GitHub-Sources (here dev-branch):

 pip install git+https://github.com/orgua/shepherd.git@dev#subdirectory=software/shepherd-calibration -U

Calibration and profiling requires a SMU from Keithley. Our tests and initial calibration are done with a Keithley 2604B SourceMeter connected via ethernet. The shepherd-cape has be installed on a beaglebone running the latest shepherd-software and also be accessible via ethernet.

Usage#

The Interface is a semi-stable ATM, so explore the commands on your own:

# to see the commands:
shepherd-cal --help
# help for individual commands, ie:
shepherd-cal calibration --help
shepherd-cal calibration measure --help
shepherd-cal profile --help

It is currently possible to:

  • calibrate the shepherd cape

  • read and write calibration to the shepherd cape

  • profile the analog frontends (harvester & emulator)

  • analyze the profiles with resulting statistics and plots

For actual measurements the program will tell you how to connect the SMU to the cape correctly.

Examples#

Calibration#

shepherd-cal calibration measure sheep0 --user jane --smu-ip 10.0.0.24 --cape-serial 1270060 --outfile sheep0_cape_v240b.yaml --verbose
shepherd-cal calibration write sheep0 --user jane --cal-file sheep0_cape_v240b.yml --verbose
# or new combined measure & write, specialized for the testbed
shepherd-cal calibration measure sheep0 --user jane --smu-ip 10.0.0.24 --emulator-only --write --verbose --cape-serial 1270057

Profiling#

shepherd-cal profile measure sheep0 --user jane --smu-ip 10.0.0.24 --cape-serial 1270057
shepherd-cal profile analyze ./ --outfile stats.csv --plot
## specialized for the testbed
shepherd-cal profile measure sheep0 --user jane --smu-ip 10.0.0.24 --cape-serial 1270057