Skip to content

Commit

Permalink
clean up readme (#467)
Browse files Browse the repository at this point in the history
  • Loading branch information
rcannood authored Sep 4, 2024
1 parent 1c9483c commit b4c415c
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 58 deletions.
41 changes: 10 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,14 @@
# OpenProblems v2
[![](https://openproblems.bio/images/heros/home_hero_text.png)](https://openproblems.bio)

------

Formalizing and benchmarking open problems in single-cell genomics.
Open Problems is a living, extensible, community-guided benchmarking platform.

[**Visit the Open Problems Website.**](https://openproblems.bio/)
Useful links:

To get started with developing a new method or metric, please see the
[OpenProblems documentation](https://openproblems.bio/documentation/).

## Benefits of using Viash

### The pipeline is **language-agnostic**

This means that each component can be written in whatever scripting
language the user desires. By default, Viash supports wrapping the
following scripting languages: Bash, Python, R, JavaScript, and Scala.
If Viash doesn’t support your preferred scripting language, you can
still write a Bash script which calls your desired programming language.

### One Docker container per component

Viash builds one Docker container per component. While this results in
some initial computational overhead, this makes it a lot easier to add a
new component to the pipeline with dependencies which might conflict
with those of other components.

### Reproducible components

A component built by viash is meant to be reproducible. All executables
and Nextflow modules in the `target/` folder in one of the
[releases](https://github.com/openproblems-bio/openproblems-v2/releases)
is fully reproducible, since all containers are published on the [GitHub
Container
Registry](https://github.com/orgs/openproblems-bio/packages?repo_name=openproblems-v2).
* [Introduction to Open Problems](https://openproblems.bio)
* [Our benchmarks](https://openproblems.bio/results)
* [Our datasets](https://openproblems.bio/datasets)
* [Our team and community](https://openproblems.bio/team)
* [Planned and past events](https://openproblems.bio/events)
* [How to contribute](https://openproblems.bio/documentation)
27 changes: 0 additions & 27 deletions README.qmd

This file was deleted.

0 comments on commit b4c415c

Please sign in to comment.