Skip to main content

A web application for exploring and comparing the overlaps across pathway resources

Project description

An integrative and extensible web application for exploring, analyzing, and curating pathway databases. ComPath is publicly available at http://compath.scai.fraunhofer.de/.

This package exposes the Bio2BEL pathway packages into a web application containing multiple built-in visualization and analytics tools allowing for their analysis and comparison. By default, this packages wraps the following default packages:

New pathway/gene signatures resources can be added by forking the ComPath Template Repository.

Installation Current version on PyPI Stable Supported Python Versions MIT License

compath can be installed easily from PyPI with the following code in your favorite terminal:

python3 -m pip install compath

or from the latest code on GitHub with:

python3 -m pip install git+https://github.com/bio2bel/compath.git@master

Setup

Easiest

After installing compath, run from the command line:

python3 -m compath populate

This command populates all of the relevant Bio2BEL repositories for the default list, and if any optional ComPath repositories have been registered with entry points, will also populated.

For Developers

If you just cloned the repo and installed it from the source code, you can run the sh script load_compath.sh by typing sh load_compath.sh in your terminal. This script will first install all packages and later populate the database.

If you have already installed the packages, but not loaded the data. First, load Bio2BEL HGNC (see ‘Mapping across gene/protein identifiers’ section). Next, load all individual pathway database packages KEGG, Reactome, WikiPathways, and MSigDB with python3 -m compath populate. This command assumes that these packages are already installed in your Python environment. You can check the packages installed by running python3 -m compath ls in your terminal. Alternatively, you can populate each package independently by running: python3 -m bio2bel_kegg populate, python3 -m bio2bel_reactome populate, python3 -m bio2bel_wikipathways populate, or python3 -m bio2bel_msig populate.

Mapping across gene/protein identifiers

In order to load the gene sets from default packages, ComPath assumes that Bio2BEL HGNC has been already installed and populated. This package is required to perform the mapping from multiple Protein/Gene identifiers to HGNC symbols. The following steps are needed to install Bio2BEL HGNC:

  1. python3 -m pip install bio2bel_hgnc

  2. python3 -m bio2bel_hgnc populate

Running the Web Application

The application can be run simply with

python3 -m compath web

This command the Flask development server locally, by default on port 5000 (http://localhost:5000).

Curation Interface

Load mappings between pathways directly from the ComPath Curation package.

python3 -m compath load_mappings

Load hierarchical mappings from a pathway database already containing that information (e.g., Reactome).

python3 -m compath load_hierarchies

Create a user.

python3 -m compath manage --connection="sqlite:////data/bio2bel.db" users make_user  'email' 'password'

Make user admin.

python3 -m compath manage --connection="sqlite:////data/bio2bel.db" users make_admin 'email'

Docker Instructions

Build Docker Image

docker build -t compath:0.0.1 .

Create Docker Containers

sh create_and_build_container.sh

Start Docker execution container

docker run --name=compath --volumes-from compath-data --restart=always -d -p 30050:5000 docker.arty.scai.fraunhofer.de/compath:latest

Load Data

docker exec -t -it compath /opt/compath/src/bin/load_data.sh

Restart Container

docker restart compath

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

compath-0.1.0.tar.gz (7.5 MB view details)

Uploaded Source

Built Distribution

compath-0.1.0-py3-none-any.whl (7.9 MB view details)

Uploaded Python 3

File details

Details for the file compath-0.1.0.tar.gz.

File metadata

  • Download URL: compath-0.1.0.tar.gz
  • Upload date:
  • Size: 7.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.7.0

File hashes

Hashes for compath-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e8a74989c2fd3520c9cfa8b878681ef5ebe92b746f7a46d6de0ee51f16197bf1
MD5 eee12dd7dd2a2094dbc2411329cec54b
BLAKE2b-256 d651510211cb3215e8d08769cb2ee6290a67b944c7a8063a7606116e9c561a52

See more details on using hashes here.

Provenance

File details

Details for the file compath-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: compath-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.7.0

File hashes

Hashes for compath-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 824c8344b1783c68e7bb5d496521f310e5e6f57e1636a53650f5c8abbfc73dcc
MD5 7ade835c8893e00a8acdf5cc880b9cc3
BLAKE2b-256 484df68d15b6c841760915a412a27ab6c209e8d59b5b582f9df9721536c897f3

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page