Skip to content

Commit

Permalink
docs: update README, add dev-all target for phirc CLI deps
Browse files Browse the repository at this point in the history
  • Loading branch information
qartik committed Jan 22, 2024
1 parent e42c997 commit 1f401de
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
.PHONY: install dev tests lint docs clean build
.PHONY: install dev dev-all tests lint docs clean build

install:
pip install .

dev:
pip install -e .

dev-all:
pip install -e .[phirc]

tests:
pytest -s -x -vv tests/test*.py

Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Install additional dependencies needed for the CLI using `pip install pytket-phi

```sh
❯ phirc -h
usage: phirc [-h] [-m {H1-1,H1-2}] [-v] qasm_files [qasm_files ...]
usage: phirc [-h] [-w WASM_FILE] [-m {H1-1,H1-2}] [-o {0,1,2}] [--verbose | --no-verbose] [-v] qasm_files [qasm_files ...]

Emulates QASM program execution via PECOS

Expand All @@ -35,12 +35,14 @@ positional arguments:

options:
-h, --help show this help message and exit
-w WASM_FILE, --wasm-file WASM_FILE
Optional WASM file for use by the QASM programs
-m {H1-1,H1-2}, --machine {H1-1,H1-2}
machine name, H1-1 by default
-o, --tket-opt-level select TKET optimization level (0 to 2, default: 0)
-w, --wasm-file path to an optional WASM file to include
-o {0,1,2}, --tket-opt-level {0,1,2}
TKET optimization level, 0 by default
--verbose, --no-verbose
-v, --version show program's version number and exit
```
## Development
Expand Down

0 comments on commit 1f401de

Please sign in to comment.