https://github.com/b-ummi/nomenclature_server

https://github.com/b-ummi/nomenclature_server

Repository

https://github.com/B-UMMI/Nomenclature_Server/blob/master/

# Nomenclature Server

## About:
This project main aim is to be used in association with chewBBaca_NS (  ). The Nomenclature Server aims to provide a free MLST data repository (wgMLST, cgMLST,etc).

## notes:
 * The implementation, by default, enforces that every sequence needs to translate into a Coding Sequence. This will also be used to query the uniprot database for more info on the protein sequence. Check the options on how to not enforce it.
 * Every submited sequence is hashed and checked against the database.
 * Sequences are species independent, while schemas, loci and isolates are not.
 * Every new species added needs to be found at  (exact string comparison). For instance: when adding `Acinetobacter calcoaceticus/baumannii complex` it will be mapped to .
 * The presented project is a basic implementation of the ontology **TypOn: the microbial typing ontology** (  ).

## Overview:
To run this you'll need (installation of the following requirements are covered at the detailed instructions) :
- python 3.xxx (developed on 3.5.2)
- flask
- virtualenv
- Some type of Database setup (e.g. postgresql, sqlite, ...)
- virtuoso triple store (developed on 06.01.3127)

# Installation detailed instructions (*UBUNTU* based):

1. get the app:
   1. create a folder where the app will be stored
   2. git pull the repository for the folder

2. Virtuoso installation
	1.  Ubutunu installation (see also )
`sudo apt-get install aptitude`
`sudo aptitude install  virtuoso-opensource`.  
Other dists (see ).
	2. Stop the running daemon of virtuoso `sudo service virtuoso-opensource-6.1 stop`. Copy the virtuoso.db file to /var/lib/virtuoso-opensource-6.1/db/ (replace if already existing). This file is preloaded with the typon and the configuration necessary to be used with the application. Restart the virtuoso daemon `sudo service virtuoso-opensource-6.1 start` 
	3. configuring your virtuoso instance
check http://localhost/8890 on your browser and go to conductor, default admin of virtuoso is set as u:dba p:dba (if you can't access directly you can jump to the next step and after rerout check http://000.000.00.00/conductor/ ).
**change the password** of dba at "system admin" -> "user accounts". Also change the user "demo" password (default password is "demo" and **should be changed**). The "demo" user will be the one used to contact with the Nomenclature server application.

3. Install nginx
`sudo apt-get install nginx`
`sudo ufw allow 'Nginx HTTP'`
    1. Configure nginx for the application:  
We are going to route virtuoso and the application, which is in port 8890 and 5000 respectively. The virtuoso rerout may be removed (security/privacy) after changing the admin and demo passwords. Also delete the default files at `/etc/nginx/sites-available/` and `/etc/nginx/sites-enable/`
Create new server configuration, save the file in /etc/nginx/sites-available/myconf.conf and copy the following to the file:
```
server {
    listen 80;
    client_header_buffer_size 30k;
    large_client_header_buffers 4 30k;

    location /app/ {
        rewrite ^/app/(.*) /$1  break;
        proxy_pass http://127.0.0.1:5000;
    }

    location ~/(conductor|sparql) {
        rewrite ^/virtuoso/?(.*) /$1 break;
        proxy_pass http://127.0.0.1:8890;
        }


}
```
Enable new configuration by creating a symbolic link in sites-enabled directory.  
`sudo ln -s /etc/nginx/sites-available/myconf.conf /etc/nginx/sites-enabled/`

4. Install redis for queue management
`sudo apt install redis-server`

5. Install postgres and create a new database called "test" with password "postgres" (change at your own preference):  
`sudo -i -u postgres`  
`psql`  
`CREATE database test;`  
#change password  
`\password postgres`  

6. Configure the app
   1. (Optional/Recommended) On the app folder run 'python3 -m venv flask' (or 'python' as long as it's calling version 3.xxx)
   2. install dependencies:  
`sudo pip3 install -r requirements.txt`
   3. Open the 'config.py' file (located on the root folder) and replace the 'SQLALCHEMY_DATABASE_URI' value with the corresponding one for your use case (for examples check ). Configure the other values in config.py: SECRET_KEY, SECURITY_PASSWORD_SALT, BASE_URL (this will be used to define the resources URI), VIRTUOSO_USER, VIRTUOSO_PASS (VIRTUOSO_USER is "demo" and VIRTUOSO_PASS the new password you defined).
   4. Open a terminal and type 'python3' (if you're using venv don't forget to activate it OR issue the command like so: 'flask/bin/python3'). Note that instead of 'python3' you might only have 'python' (maybe you have both). As long as it is version 3.xxx there's probably no problem. 
   5. Inside the interactive python shell initialize the Database:
 		- from app import db
 		- db.drop_all()
 		- db.create_all()
 		- exit()

    6. Having exited the python shell, you should now be able to run the application with: './run.py' (if needed set permissions: chmod a+x run.py). Also take into consideration to run it on a screen environment.

# API described at:



# First time usage:

1. Create the "admin" user:
   1. To create a user, use the `user_management.py` script at `$path2App/app/scripts/`, provide an email, a pass and a role ("Admin" or "User") and it will return your token.
   2. Users with "Admin" role are the only allowed to create a schema. **Schema creation is not allowed to other users**.
2. Create Schemas:
   1. Create a Schema based on a set of fasta files:  
Use the `load_schema.py` script at `$path2App/app/scripts/` (use the `-h` flag for more info on how to use). `-t` flag is to be used with the token made on 1.
   2. Create a Schema based on a set of loci already on the nomenclature server:  
Use the `load_schema_no_fasta.py` script at `$path2App/app/scripts/` (use the `-h` flag for more info on how to use). `-t` flag is to be used with the token made on 1.

# Backing up data:

1. Backing up virtuoso data:
   1. You can just save the virtuoso.db that should be at /var/lib/virtuoso-opensource-6.1/db/. To load it just copy the file to the same directory
   2. You can also dump the graph. Check http://docs.openlinksw.com/virtuoso/rdfperfdumpandreloadgraphs/ to do it. This is specially useful to edit the RDF. 
   3. To load a dumped graph check http://vos.openlinksw.com/owiki/wiki/VOS/VirtBulkRDFLoader.

2. Backing up Postgres:
   1. `psql dbname > outfile`
   2. to load just do `psql dbname < outfile`


# Future work
 - try latest virtuoso version (latest 6.x.xxx or 7)
 - improve users management
 - improve api user inputs sanitization

Owner

GitHub Events