-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
47 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,20 +14,41 @@ Path to source: | |
|
||
## Installation | ||
|
||
You need to have Docker, Java, and Viash installed. Follow [these | ||
instructions](https://openproblems.bio/documentation/fundamentals/requirements) | ||
You need to have Docker, Java, and Viash installed. Follow | ||
[these instructions](https://openproblems.bio/documentation/fundamentals/requirements) | ||
to install the required dependencies. | ||
|
||
## First steps | ||
|
||
To get started, you can run the following commands: | ||
|
||
``` bash | ||
```bash | ||
git clone [email protected]:openproblems-bio/task-dge-perturbation-prediction.git | ||
|
||
cd task-dge-perturbation-prediction | ||
|
||
scripts/sync_resources.sh | ||
# download resources | ||
scripts/download_resources.sh | ||
``` | ||
|
||
To run the benchmark, you first need to build the components. Afterwards, you can run the benchmark: | ||
|
||
```bash | ||
viash ns build --parallel --setup cachedbuild | ||
|
||
scripts/run_benchmark.sh | ||
``` | ||
|
||
After adding a component, it is recommended to run the tests to ensure that the component is working correctly: | ||
|
||
```bash | ||
viash ns test --parallel | ||
``` | ||
|
||
Optionally, you can provide the `--query` argument to test only a subset of components: | ||
|
||
```bash | ||
viash ns test --parallel --query "component_name" | ||
``` | ||
|
||
## Motivation | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,8 +16,29 @@ readme: | | |
git clone [email protected]:openproblems-bio/task-dge-perturbation-prediction.git | ||
cd task-dge-perturbation-prediction | ||
# download resources | ||
scripts/download_resources.sh | ||
``` | ||
To run the benchmark, you first need to build the components. Afterwards, you can run the benchmark: | ||
```bash | ||
viash ns build --parallel --setup cachedbuild | ||
scripts/run_benchmark.sh | ||
``` | ||
scripts/sync_resources.sh | ||
After adding a component, it is recommended to run the tests to ensure that the component is working correctly: | ||
```bash | ||
viash ns test --parallel | ||
``` | ||
Optionally, you can provide the `--query` argument to test only a subset of components: | ||
```bash | ||
viash ns test --parallel --query "component_name" | ||
``` | ||
motivation: | | ||
Human biology can be complex, in part due to the function and interplay of the body's | ||
|