Skip to main content

BEL Commons Travis-CI Build Status Documentation Status

An environment for curating, validating, and exploring knowledge assemblies encoded in Biological Expression Language (BEL) to support elucidating disease-specific, mechanistic insight.

Installation

BEL Commons can be installed easily from PyPI with the following code in your favorite shell:

$ pip install bel_commons

Get the latest code on GitHub with:

$ python3 -m pip install git+https://github.com/bel-commons/bel-commons.git

It’s also suggested to use a relational database management system like PostgreSQL and install their corresponding connectors:

$ python3 -m pip install psycopg2-binary

Usage

Run BEL Commons

A test server can be easily run with:

$ bel-commons run

A more powerful server like gunicorn can also be used like:

$ gunicorn bel_commons.wsgi:flask_app

Running with the Parser

To run the parser, you’ll need an instance of a message queue like RabbitMQ (or any other message queue supported by Celery), a results backend like Redis, and a worker. It’s best to run in docker if you want to do this.

Run with Docker

Clone this repo from GitHub

$ git clone https://github.com/bel-commons/bel-commons.git
$ cd bel-commons

Create a file called .env and generate both SECRET_KEY and SECURITY_PASSWORD_SALT.

SECRET_KEY=mypassword
SECURITY_PASSWORD_SALT=mypassword
BUTLER_NAME="BEL Commons Butler"
BUTLER_EMAIL=bel@example.com
BUTLER_PASSWORD=butlerpassword

Run docker compose:

$ docker-compose up

Ports exposed:

  • 5002: BEL Commons web application

  • 5432: PostgreSQL database

Reset the Database

For the times when you just have to burn it down and start over:

  1. bel-commons manage drop will nuke the database and output a user list

  2. bel-commons manage load will automatically add the most recently exported user list

  3. bel-commons manage examples load will automatically load some example networks and data sets

Citation

If you find BEL Commons useful in your work, please consider citing [Hoyt2018] and [Hoyt2017]:

[Hoyt2018]

Hoyt, C. T., Domingo-Fernández, D., & Hofmann-Apitius, M. (2018). BEL Commons: an environment for exploration and analysis of networks encoded in Biological Expression Language. Database, 2018(3), 1–11.

[Hoyt2017]

Hoyt, C. T., Konotopez, A., & Ebeling, C., (2017). PyBEL: a computational framework for Biological Expression Language. Bioinformatics, 34(4), 703–704.

Acknowledgements

Supporters

This project has been supported by several organizations:

Metadata

Release files for bel-commons 0.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bel-commons 0.3.1
File Size Uploaded Provenance Actions
bel_commons-0.3.1.tar.gz 3.6 MB Without provenance Details for bel_commons-0.3.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for bel-commons 0.3.1
File Interpreter ABI Platform Actions
bel_commons-0.3.1-py3-none-any.whl Python 3 none any Details for bel_commons-0.3.1-py3-none-any.whl

Total release size: 7.3 MB

Release files / bel_commons-0.3.1.tar.gz

Download URL bel_commons-0.3.1.tar.gz
Size 3.6 MB
Tags Source
SHA-256 checksum
How to use checksums
afcf13298326cc8c0d63fad80dd015d3da7c31b672225c3310882a647c47cfbd
BLAKE2b-256 checksum
How to use checksums
c39bfb1cce7201a1be685d20352388789873512e95934ae321f6cefd948fc64b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7

Release files / bel_commons-0.3.1-py3-none-any.whl

Download URL bel_commons-0.3.1-py3-none-any.whl
Size 3.7 MB
Tags Python 3
SHA-256 checksum
How to use checksums
3a0439c81c4e0177aa58e7826b9804feb68a0b003a022008f6e10bbab977abf7
BLAKE2b-256 checksum
How to use checksums
c298b6bc7c4ab40724b982076d2599d7afb2010c1a3edec9db7ca435c26c7917
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7

Security for bel-commons 0.3.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.3.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page