Examples¶
This directory contains examples how to use tierkreis to write workflows. Before writing workflows, we will shortly recap how to write a worker. It is intended that these notebooks are read in the following order.
- Writing tierkreis workers
- Hello World: Tierkreis Edition
- Configuring Storage and Executors, Submitting to Quantinuum, Using Predefined Workers
- Complex types, optional values
- Tierkreis checkpoints; using pre build graphs
- Leveraging parallelism through map
- Errors and Debugging
- Restarting nodes
- Non-python workers, Multiple Executors
- Tierkreis and HPC
- Custom Serializers
- Hamiltonian Simulation
- QSCI
How to use¶
In the given examples you will be developing code involving tierkreis workers.
Whenever you see an import containing *_worker this means one of the workers will be invoked (except for the builtins).
To ensure the examples will run correctly you will need to have the worker code available too.
The simplest way to set this up is to clone the entire repository before running any of the examples.
git clone https://github.com/Quantinuum/tierkreis.git
To set up the environment we us uv:
uv sync --all-extras
When running the notebooks select the kernel corresponding to the uv environment.