README.md 1.38 KB
Newer Older
Ninjani's avatar
Ninjani committed
1
2
# Turterra

Terlouw, Barbara's avatar
Terlouw, Barbara committed
3
Turterra is a portal for analysing protein families. It consists of two main parts: turterra, which runs a web portal from a folder tree, and turterra-build, which creates any files in the folder tree that may be missing from a .fasta file and a directory containing templates for homology modelling.
Ninjani's avatar
Ninjani committed
4
5
6

## Installation

Terlouw, Barbara's avatar
Terlouw, Barbara committed
7
8
9
10
11
12
13
14
15
16
17
Turterra and turterra-build are installed together as follows:

First, we recommend you install [Anaconda](https://www.anaconda.com/products/individual-b) or [Miniconda](https://docs.conda.io/en/latest/miniconda.html). Then, create a new conda environment for turterra and activate it:

```sh
conda create -n turterra python=3.9
conda activate turterra
```

Next, clone the turterra repository into a location of your choice, navigate to the folder, and install turterra.

Ninjani's avatar
Ninjani committed
18
19
20
21
22
23
```sh
conda install -c bioconda epa-ng hmmer muscle fasttree
git clone https://github.com/TurtleTools/turterra.git
cd turterra
pip install .
```
Terlouw, Barbara's avatar
Terlouw, Barbara committed
24
25
26
27
28
29
30
31
32
33
34

The majority of turterra's dependencies are installed through the provided setup.py file. However, some dependencies will need to be installed through conda.

```sh
conda install -c bioconda epa-ng hmmer muscle fasttree
```

Congratulations! Turterra was installed!

##Turterra folder architecture

Terlouw, Barbara's avatar
Terlouw, Barbara committed
35
36
In order to run turterra with your own data, create a folder called 'data' in the top-level folder called turterra. This folder should contain the following files:

Terlouw, Barbara's avatar
Terlouw, Barbara committed
37
38
39
40