Skip to main content

Unambiguous representation of modified DNA, RNA, and proteins

Project description

PyPI package Documentation Test results Test coverage Code analysis License Analytics

BpForms: toolkit for concretely describing non-canonical DNA, RNA, and proteins

BpForms is a set of tools for concretely representing the primary structures of non-canonical forms of biopolymers, such as oxidized DNA, methylated RNA, and acetylated proteins, and calculating properties of non-canonical biopolymers.

BpForms encompasses five tools:

  • A grammar for concretely describing the primary structures of non-canonical biopolymers. See the documentation for more information. For example, the following text represents a modified DNA molecule that contains a deoxyinosine monomeric form at the fourth position. ACG[id: "dI" | structure: "[H][C@]1(O)C[C@@]([H])(O[C@]1([H])CO)N1C=NC2=C1N=CN=C2O"]T

This concrete representation enables the BpForms software tools to calculate properties of non-canonical biopolymers.

  • Tools for calculating properties of non-canonical biopolymers including their chemical formulae, molecular weights, charges, and major protonation and tautomerization states.

  • A web app: https://bpforms.org

  • A JSON REST API: https://bpforms.org/api

  • A command line interface. See the documentation for more information.

  • A Python API. See the documentation for more information.

BpForms was motivated by the need to concretely represent the biochemistry of DNA modification, DNA repair, post-transcriptional processing, and post-translational processing in whole-cell computational models. BpForms is also a valuable tool for experimental proteomics and synthetic biology. In particular, we developed BpForms because there were no notations, schemas, data models, or file formats for concretely representing non-canonical forms of biopolymers, despite the existence of several databases and ontologies of DNA, RNA, and protein modifications, the ProForma Proteoform Notation, and the MOMODICS codes for modified RNA bases.

BpForms can be combined with *BcForms* to concretely describe the primary structure of complexes.

Installation

  1. Install the third-party dependencies listed below. Detailed installation instructions are available in An Introduction to Whole-Cell Modeling.

  2. To use Marvin to calculate major protonation and tautomerization states, set JAVA_HOME to the path to your Java virtual machine (JVM) export JAVA_HOME=/usr/lib/jvm/default-java

  3. To use Marvin to calculate major protonation and tautomerization states, add Marvin to the Java class path export CLASSPATH=$CLASSPATH:/opt/chemaxon/marvinsuite/lib/MarvinBeans.jar

  4. Install this package

    • Install the latest release from PyPI: pip install bpforms

    • Install the latest revision from GitHub: pip install git+https://github.com/KarrLab/wc_utils.git#egg=wc_utils[all] pip install git+https://github.com/KarrLab/bpforms.git#egg=bpforms

    • To install the rest API, BpForms must be installed with the [all] option: pip install bpforms[all] pip install git+https://github.com/KarrLab/bpforms.git#egg=bpforms[all]

Examples, tutorial, and documentation

Please see the documentation. An interactive tutorial is also available in the whole-cell modeling sandbox.

License

The package is released under the MIT license.

Citing BpForms

Lang PF, Chebaro Y & Jonathan R. Karr. BpForms: a toolkit for concretely describing modified DNA, RNA and proteins. arXiv:1903.10042. :link:

Development team

This package was developed by the Karr Lab at the Icahn School of Medicine at Mount Sinai in New York, USA.

Questions and comments

Please contact the Karr Lab with any questions or comments.

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

bpforms-0.0.13.tar.gz (333.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bpforms-0.0.13-py2.py3-none-any.whl (345.2 kB view details)

Uploaded Python 2Python 3

File details

Details for the file bpforms-0.0.13.tar.gz.

File metadata

  • Download URL: bpforms-0.0.13.tar.gz
  • Upload date:
  • Size: 333.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.7.5

File hashes

Hashes for bpforms-0.0.13.tar.gz
Algorithm Hash digest
SHA256 28c3f7ad6d36d1ee79e6f8f6da5f23eaeb96f1803ee89429765f2015894cc50d
MD5 d6d34cad4ee5d558269549421ab1b46b
BLAKE2b-256 efe34227c9734c6c25db3544192d6ee5a8cc0e3dd770a64091681a01626f9096

See more details on using hashes here.

File details

Details for the file bpforms-0.0.13-py2.py3-none-any.whl.

File metadata

  • Download URL: bpforms-0.0.13-py2.py3-none-any.whl
  • Upload date:
  • Size: 345.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.7.5

File hashes

Hashes for bpforms-0.0.13-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6dd5d46172c8418fd20cb527480555c1f78247249e12fdc258f9fcff086a14fb
MD5 9fdd3975b1257093d6935eaa45cc4ca1
BLAKE2b-256 8d0f845cbeb5ba956d0ac3dd6aca103355fb29bbed961ff3cfa40f900a3ccc3e

See more details on using hashes here.

Supported by

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