Skip to main content

BoNesisTools is a python package proposing bioinformatics tools for upstream and downstream analysis of BoNesis framework

Project description

tests PyPI python license

BoNesisTools

BoNesisTools is a Python package providing utilities for Boolean modelling, regulatory interaction graphs and single-cell analyses around the BoNesis ecosystem.

The package provides:

  • Boolean algebra and partial Boolean abstractions
  • Boolean network manipulation and analysis
  • signed interaction and influence graph utilities
  • GRN-informed Boolean predecessor inference
  • single-cell and multimodal analysis helpers
  • biological database interfaces

Usage

import bonesistools as bt

BoNesisTools exposes four main namespaces:

  • bt.sct — single-cell and multimodal annotated data tools
  • bt.bpy — Boolean modelling and graph utilities
  • bt.dbs — biological database interfaces
  • bt.grn — deprecated alias for bt.bpy.ig

Single-cell tools

bt.sct follows a Scanpy-like API while providing additional and complementary features for single-cell analyses.

Submodules:

  • preprocessing: bt.sct.pp
  • tools: bt.sct.tl
  • plotting: bt.sct.pl
  • datasets: bt.sct.datasets

Boolean modelling utilities

bt.bpy provides utilities for Boolean modelling, logical abstractions and signed regulatory graphs.

Submodules:

Submodules:

  • Boolean algebra: bt.bpy.ba

    • partial Boolean abstractions and hypercube representations
    • Boolean differential and predecessor inference utilities
  • Boolean network: bt.bpy.bn

    • Boolean network manipulation and analysis
    • fixed-point computation
    • .bnet import/export
  • influence graph: bt.bpy.ig

    • signed regulatory interaction graphs
    • feedback circuit and SCC analysis
    • signed interaction scoring from bounded walks
    • graph compression and visualization utilities

Example:

bn = bt.bpy.bn.BooleanNetwork(
    {
        "A": "B & ~C",
        "B": 1,
        "C": 0,
    }
)

graph = bn.to_influence_graph()

graph.show()

Biological external resources

bt.dbs provides lightweight interfaces and utilities for biological external resources.

Submodules:

  • NCBI: bt.dbs.ncbi

    • gene synonym harmonization
    • gene annotation utilities
  • OmniPath: bt.dbs.omnipath

    • DoRothEA transcription factor interactions
    • CollecTRI regulatory interaction networks

Example:

genesyn = bt.dbs.ncbi.GeneSynonyms()

grn = bt.dbs.omnipath.load_collectri_grn(
    organism="mouse",
    genesyn=genesyn,
)

Installation

Install the latest release:

pip install bonesistools

Install the single-cell dependencies:

pip install "bonesistools[sctools]"

Install all optional dependencies:

pip install "bonesistools[all]"

Install the development version:

git clone https://github.com/bnediction/bonesistools.git
cd bonesistools
pip install -e ".[all]"

or directly:

pip install git+https://github.com/bnediction/bonesistools.git

Bugs

Please report bugs or ask questions here:

https://github.com/bnediction/bonesistools/issues


License

This package is distributed under the CeCILL v2.1 free software license (GNU GPL compatible).

This package also includes third-party data resources derived from the NCBI Gene database (gene_info). NCBI places no restrictions on the use or redistribution of these data: https://www.ncbi.nlm.nih.gov/home/about/policies/

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

bonesistools-1.2.1.tar.gz (9.4 MB view details)

Uploaded Source

Built Distribution

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

bonesistools-1.2.1-py3-none-any.whl (9.7 MB view details)

Uploaded Python 3

File details

Details for the file bonesistools-1.2.1.tar.gz.

File metadata

  • Download URL: bonesistools-1.2.1.tar.gz
  • Upload date:
  • Size: 9.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for bonesistools-1.2.1.tar.gz
Algorithm Hash digest
SHA256 00b58754947a7357a4050ce0258af67cbdf08c1e1471c6768051e1efcbbd4e8e
MD5 f8d60c26e55b3228ade9cae8868d1078
BLAKE2b-256 c75fa28603239b49369bd3b5c1ee649913f7946a6f79f55c0da44612ba2d1b97

See more details on using hashes here.

Provenance

The following attestation bundles were made for bonesistools-1.2.1.tar.gz:

Publisher: publish.yml on bnediction/bonesistools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bonesistools-1.2.1-py3-none-any.whl.

File metadata

  • Download URL: bonesistools-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 9.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for bonesistools-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8cca38d3195eb95631a5dee787a420e30561fa739faca2dd3db703dc9ef16651
MD5 db8109edcebc4cd33ce9dcbe0e315144
BLAKE2b-256 a3f81662f5ade5082703b0708de1d4b246770fe94ca289b488c5ca15f148f7ee

See more details on using hashes here.

Provenance

The following attestation bundles were made for bonesistools-1.2.1-py3-none-any.whl:

Publisher: publish.yml on bnediction/bonesistools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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