Skip to content

Commit

Permalink
Updating README and docs for v1 release (#410)
Browse files Browse the repository at this point in the history
Related-Issue: #410
Projected-Results-Impact: none
  • Loading branch information
holtgrewe committed Mar 28, 2022
1 parent 63071b5 commit 8cf28cc
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 11 deletions.
24 changes: 19 additions & 5 deletions README.rst
Expand Up @@ -63,12 +63,26 @@ At a Glance
GitHub is used for public issue tracking.
Currently, development happens on internal infrastructure.

-------------------------------------
VarFish Component Compatibility Table
-------------------------------------

The following combinations have been validated / are supported to work.

============== =========== =================
VarFish Server VarFish CLI VarFish Annotator
============== =========== =================
v1.*.* v0.3.0 v0.20
============== =========== =================

----------------------------------------
VarFish Data Release Compatibility Table
----------------------------------------

===================== ============ ==============
VarFish DB Downloader Data Release VarFish Server
===================== ============ ==============
v0.2 20201006 <= v0.23
===================== ============ ==============
The following combinations have been validated / are supported to work.

============== ============ =====================
VarFish Server Data Release VarFish DB Downloader
============== ============ =====================
v1.*.* 20210728 v0.3.0
============== ============ =====================
@@ -1,8 +1,8 @@
.. _dev_docker:
.. _developer_data_builds:

=============
Docker Builds
=============
====================
Docker & Data Builds
====================

This section describes how to build the Docker images and also the VarFish site data tarballs.
The intended audience are VarFish developers.
Expand Down Expand Up @@ -67,7 +67,7 @@ Download static data
::

$ cd /plenty/space
$ wget https://file-public.bihealth.org/transient/varfish/varfish-server-background-db-20201006.tar.gz{,.sha256}
$ wget https://file-public.bihealth.org/transient/varfish/athenea/varfish-server-background-db-20201006.tar.gz{,.sha256}
$ sha256sum -c varfish-server-background-db-20201006.tar.gz.sha256
$ tar xzvf varfish-server-background-db-20201006.tar.gz

Expand Down Expand Up @@ -109,6 +109,13 @@ Add Other Data
--------------

Copy the other required data for ``jannovar`` and ``exomiser``.
You can find the appropriate files to download on the Jannovar (via Zenodo) and Exomiser data download sites:

- https://zenodo.org/record/5410367
- https://data.monarchinitiative.org/exomiser/data/index.html

You should use the hg19 data for Exomiser for any genome release as we will only use the the gene to phenotype prioritization that is independent of the genome release.

The result should look similar to this:

::
Expand Down
2 changes: 1 addition & 1 deletion docs_manual/index.rst
Expand Up @@ -153,6 +153,7 @@ Currently, the main focus is on small/sequence variants called from high-througp
developer_kiosk
developer_templates
developer_checklists
developer_data_builds

.. raw:: latex

Expand Down Expand Up @@ -183,7 +184,6 @@ Currently, the main focus is on small/sequence variants called from high-througp
release_cycle
history
glossary
dev_docker

Indices and tables
==================
Expand Down

0 comments on commit 8cf28cc

Please sign in to comment.