Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rcannood committed Apr 18, 2024
1 parent 853e8b4 commit a4612e0
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 5 deletions.
29 changes: 25 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
23 changes: 22 additions & 1 deletion src/task/api/task_info.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit a4612e0

Please sign in to comment.