README.rst 2.41 KB
Newer Older
Rudel Fankep's avatar
Rudel Fankep committed
1
2
3
4
5
6
7
8
9
Database Manager
================

This tool provide the preparation of Databases for several bioinformaticians tools.
The preparated databases can be used on the working computer or can be saved on the cloud Server(Amazon Web Service S3)
so that other computer can be able to download the data from there. It's also possible to delete some undesirable 
databases on the working computer and/or in the Cloud.

Supported Databases with associated tools:
Rudel Fankep's avatar
Rudel Fankep committed
10

Rudel Fankep's avatar
Rudel Fankep committed
11
12
13
14
15
16
17
18
* Uniprot-Swissprot [Blast, Ghostx]
* CARD [Blast, Ghostx]
* Pfam [hmmer]

Installation
------------

Prerequisites:
Rudel Fankep's avatar
Rudel Fankep committed
19

Rudel Fankep's avatar
Rudel Fankep committed
20
21
22
23
* Python (Version >= 3.7)
* Git

Install for user::
Rudel Fankep's avatar
Rudel Fankep committed
24

Rudel Fankep's avatar
Rudel Fankep committed
25
26
27
    pip install git+https://git.computational.bio.uni-giessen.de/cfankep/psotdb.git

Install for developer::
Rudel Fankep's avatar
Rudel Fankep committed
28

Rudel Fankep's avatar
Rudel Fankep committed
29
30
31
32
33
34
35
36
37
    #checkout repository
    git clone git+https://git.computational.bio.uni-giessen.de/cfankep/psotdb.git

    #install
    pip3 install -e .


Using Database Manager
----------------------
Rudel Fankep's avatar
Rudel Fankep committed
38

Rudel Fankep's avatar
Rudel Fankep committed
39
For the general help use::
Rudel Fankep's avatar
Rudel Fankep committed
40

Rudel Fankep's avatar
Rudel Fankep committed
41
42
    dbman --help

Rudel Fankep's avatar
Rudel Fankep committed
43
Checkout which databases are available::
Rudel Fankep's avatar
Rudel Fankep committed
44

Rudel Fankep's avatar
Rudel Fankep committed
45
46
47
48
49
50
    # in the S3 directory
    dbman list_remote_databases

    # in the local directory
    dbman list_local_databases 

Rudel Fankep's avatar
Rudel Fankep committed
51
Checkout which databases with associated transformations are available::
Rudel Fankep's avatar
Rudel Fankep committed
52

Rudel Fankep's avatar
Rudel Fankep committed
53
54
    dbman list_recipes

Rudel Fankep's avatar
Rudel Fankep committed
55
Prepare databases::
Rudel Fankep's avatar
Rudel Fankep committed
56

Rudel Fankep's avatar
Rudel Fankep committed
57
58
    # check the available optional parameters
    dbman prepare -h
Rudel Fankep's avatar
Rudel Fankep committed
59

Rudel Fankep's avatar
Rudel Fankep committed
60
61
62
    # run the standard preparation
    dbman prepare example/database exemple/tool

Rudel Fankep's avatar
Rudel Fankep committed
63
Transfer databases from the working computer to s3 Cloud::
Rudel Fankep's avatar
Rudel Fankep committed
64

Rudel Fankep's avatar
Rudel Fankep committed
65
66
    # check the available optional parameters
    dbman upload -h
Rudel Fankep's avatar
Rudel Fankep committed
67

Rudel Fankep's avatar
Rudel Fankep committed
68
    # run the standard transfer
Rudel Fankep's avatar
Rudel Fankep committed
69
    dbman upload example/database exemple/tool*
Rudel Fankep's avatar
Rudel Fankep committed
70

Rudel Fankep's avatar
Rudel Fankep committed
71
Transfer databases from s3 Cloud to working computer::
Rudel Fankep's avatar
Rudel Fankep committed
72

Rudel Fankep's avatar
Rudel Fankep committed
73
74
    # check the available optional parameters
    dbman download -h
Rudel Fankep's avatar
Rudel Fankep committed
75

Rudel Fankep's avatar
Rudel Fankep committed
76
    # run the standard download
Rudel Fankep's avatar
Rudel Fankep committed
77
    dbman download example/database exemple/tool*
Rudel Fankep's avatar
Rudel Fankep committed
78

Rudel Fankep's avatar
Rudel Fankep committed
79
Delete undesirable databases::
Rudel Fankep's avatar
Rudel Fankep committed
80

Rudel Fankep's avatar
Rudel Fankep committed
81
    # from the local directory
Rudel Fankep's avatar
Rudel Fankep committed
82
    dbman delete example/database example/tool* local
Rudel Fankep's avatar
Rudel Fankep committed
83

Rudel Fankep's avatar
Rudel Fankep committed
84
    # from the s3 cloud directory
Rudel Fankep's avatar
Rudel Fankep committed
85
    dbman delete example/database example/tool* s3
Rudel Fankep's avatar
Rudel Fankep committed
86

Rudel Fankep's avatar
Rudel Fankep committed
87
remplace the standard directory to save the data::
Rudel Fankep's avatar
Rudel Fankep committed
88

Rudel Fankep's avatar
Rudel Fankep committed
89
90
    # change local directory with the environment variable
    export DBMAN_DBDIR = example/path
Rudel Fankep's avatar
Rudel Fankep committed
91

Rudel Fankep's avatar
Rudel Fankep committed
92
93
94
95
96
97
98
    # change remote directory with the environment variable
    export DBMAN_S3DIR = example/path

The standard directories(local and remote) can also be change with optional parameters. 



Rudel Fankep's avatar
Rudel Fankep committed
99
(*) For upload, download and delete of the raw databank instead of 'example/tool' enter 'raw'.