Skip to content
This repository has been archived by the owner on Apr 7, 2022. It is now read-only.

Commit

Permalink
rename quisp_run -> crispr
Browse files Browse the repository at this point in the history
  • Loading branch information
zigen committed Jan 8, 2022
1 parent a91a595 commit 6acdc22
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 12 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# QuISP Benchmark Runner
# CRISPR: QuISP Benchmark Runner

## Prerequisites
* Poetry
Expand All @@ -12,31 +12,31 @@ $ poetry install
# (if you don't want to make your environment dirty)
$ poetry shell

# install quisp command in editable mode
# install crispr command in editable mode
$ pip install -e .

# then you can use the "quisp" command
# then you can use the "crispr" command
# show help
$ quisp --help
$ crispr --help
```
## Usage
```sh
# validate your plan file
$ quisp plan ./simulation.plan
$ crispr plan ./simulation.plan

# run all simulations
$ quisp run ./simulation.plan -r ../your-quisp-repository -o ../output-dir
$ crispr run ./simulation.plan -r ../your-quisp-repository -o ../output-dir

# run simulations with 16 workers
$ quisp run ./simulation.plan -r ../your-quisp-repository -o ../output-dir -p 16
$ crispr run ./simulation.plan -r ../your-quisp-repository -o ../output-dir -p 16

# and you can type Ctrl-C to stop the simulations

# then you can resume the stopped simulation
$ quisp resume
$ crispr resume

# you can check the stopped simulations status
$ quisp status
$ crispr status
```

## Results Directory
Expand Down
5 changes: 2 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[tool.poetry]
name = "quisp_run"
name = "crispr"
version = "0.1.0"
description = ""
authors = ["zigen <hrlclb@gmail.com>"]
Expand All @@ -23,8 +23,7 @@ build-backend = "poetry.core.masonry.api"


[tool.poetry.scripts]
quisp_run = "quisp_run.main:main"
quisp = "quisp_run.main:main"
crispr = "quisp_run.main:main"

[tool.poetry.build]
generate-setup-file = false
Expand Down

0 comments on commit 6acdc22

Please sign in to comment.