Skip to content

sandipchatterjee/biome

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Biome

Python-based web application for metaproteomic analysis of microbiome samples

Major Requirements

  • Python 3.4+
  • Flask
  • Pandas/NumPy
  • PostgreSQL 9.4+ (local or remote)
  • see requirements.txt for details

Getting Started

  • Clone this repo and cd into root (biome) directory
  • Create a virtualenv: $ pyvenv venv
  • Activate virtualenv: $ source venv/bin/activate
  • Install dependencies: (venv) $ pip install -r requirements.txt
  • Create PostgreSQL database. Access Postgres with psql and run: CREATE DATABASE biome;
  • Create database tables: (venv) $ python manage.py db upgrade
  • Config can be set using the $BIOME_CONFIG environment variable (see config.py)
  • Run (dev) server: (venv) $ python manage.py runserver

Starting Celery Task Queue

(optional, but needed for some functionality)

  • Launch Redis: redis-server (connection details are in config.py)
  • Launch Celery worker (can launch in the foreground using a second terminal window)
    • Activate venv in new terminal: $ source venv/bin/activate
    • Launch worker process: (venv) $ celery worker -A biome.celery --loglevel=info

Testing

  • Create PostgreSQL testing database. Access Postgres with psql and run: CREATE DATABASE biometesting;
  • Change to root (biome) directory and run: (venv) $ python -m unittest discover

About

Python-based web application for metaproteomic analysis of microbiome samples

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages