Skip to content

Commit 67f549f

Browse files
aborgna-qlmondada
andauthored
docs: Add tket-c-api setup recipe and instructions (#960)
Co-authored-by: Luca Mondada <72734770+lmondada@users.noreply.github.com>
1 parent 4c8a13c commit 67f549f

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

DEVELOPMENT.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,13 @@ devenv shell
2424
All the required dependencies should be available. You can automate loading the
2525
shell by setting up [direnv](https://devenv.sh/automatic-shell-activation/).
2626

27+
<!-- TODO: Remove once the pre-compiled binaries are available. -->
28+
Currently you will need to compile the tket C API manually. To do this, run:
29+
```bash
30+
just setup-tket-c-api
31+
```
32+
This step will be removed in the future, once the pre-compiled binaries are available.
33+
2734
### Manual setup
2835

2936
To setup the environment manually you will need:

justfile

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,15 @@ help:
44

55
# Prepare the environment for development, installing all the dependencies and
66
# setting up the pre-commit hooks.
7-
setup:
7+
setup: setup-tket-c-api
88
uv sync
99
[[ -n "${TKET2_JUST_INHIBIT_GIT_HOOKS:-}" ]] || uv run pre-commit install -t pre-commit
1010

11+
# Configure the conan cache for tket-c-api.
12+
setup-tket-c-api:
13+
uv run conan remote add -f tket-libs https://quantinuumsw.jfrog.io/artifactory/api/conan/tket1-libs --index 0
14+
cd tket1-passes/tket-c-api && uv run conan create . --build=missing
15+
1116
# Run the pre-commit checks.
1217
check:
1318
uv run pre-commit run --all-files

0 commit comments

Comments
 (0)