GGet started
q-twin runs on Python 3.12 on Linux or on macOS with Apple Silicon. Five steps take you from source to a first study report.
- 1
Get the source
The repository opens to the public soon under FSL-1.1-ALv2. Source · soon
- 2
Install the engine and dashboard
Install in a virtual environment, with the dashboard and test extras.
$ pip install -e ".[api,test]" - 3
Add the PDK extra to run studies
Studies need the PDK adapters. On an Intel Mac, skip this step: one dependency ships no wheel there, so the dashboard shows existing runs but cannot make new ones.
$ pip install -e ".[pdk]" - 4
Run a study on an example pack
Every study takes
--design. Start with S-2, calibration yield, on one of the example packs, or on your own.$ python -m studies.s2_calibration --design <your-pack> - 5
Open the dashboard
See every gate at every corner, the figures and the report, on
http://127.0.0.1:8000/.$ uvicorn api.main:app --reload
G.1Next: your own pack
Copy an example pack into designs/, change the values, and label each one measured, literature, calculated or target with its source. The loader rejects a value without a label. See the pack map for what each file does.
G.2Hosted public beta
Prefer not to install? The hosted beta builds packs on seven screens and runs studies on our server within a quota. Request access.