From 0c94e798d5160bce9af9b1c3ad13d9dbd21c3597 Mon Sep 17 00:00:00 2001 From: Rhys Newell <42852939+rhysnewell@users.noreply.github.com> Date: Thu, 28 Apr 2022 08:47:09 +1000 Subject: [PATCH] Update: Databse info added --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 383a5082..7ed5d2ed 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,20 @@ Initial requirements for aviary can be downloaded using the `aviary.yml`: conda env create -n aviary -f aviary.yml ``` +## Databases + +Aviary uses programs which require access to locally stored databases. These databases can be quite large, as such we recommend setting up one instance of Aviary and these databases per machine or machine cluster. + +The **required** databases are as follows: +* [GTDB](https://gtdb.ecogenomic.org/downloads) Required for taxonomic annotation + +The **optional** databases are as follows: +* [EggNog](https://github.com/eggnogdb/eggnog-mapper/wiki/eggNOG-mapper-v2.1.5-to-v2.1.7#setup) Will become required soon. +* [EnrichM](https://github.com/geronimp/enrichM) +* Busco + +**If you do not have the optional databases installed, then when aviary asks you to specify these databse passes when configuring just press enter and specify no path.** + # Module details |__method__ |__description__ | | --- | --- |