Skip to content

Commit

Permalink
remove readme field from task_info
Browse files Browse the repository at this point in the history
  • Loading branch information
KaiWaldrant committed Jul 4, 2024
1 parent 692c02e commit c13fea4
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 47 deletions.
2 changes: 1 addition & 1 deletion common
46 changes: 0 additions & 46 deletions src/api/task_info.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,52 +2,6 @@ name: A unique identifier. Can only contain lowercase letters, numbers or unders
label: A unique, human-readable, short label. Used for creating summary tables and visualisations.
summary: A one sentence summary of purpose and methodology. Used for creating an overview tables.
image: The name of the image file to use for the component on the website.
readme: |
## Installation
You need to have Docker, Java, and Viash installed. Follow
[these instructions](https://openproblems.bio/documentation/fundamentals/requirements)
to install the required dependencies.
## Add a method
To add a method to the repository, follow the instructions in the `scripts/add_a_method.sh` script.
## Frequently used commands
To get started, you can run the following commands:
```bash
git clone [email protected]:openproblems-bio/task_<task-name>.git
cd <task-name>
# initialise submodule
scripts/init_submodule.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: |
Explain the motivation behind your proposed task. Describe the biological or computational
problem you aim to address and why it’s important. Discuss the current state of research in
Expand Down

0 comments on commit c13fea4

Please sign in to comment.