Skip to main content

Boolean Attractor Landscape Mapper

Project description

PyPI Api Docs Continuous integration GitHub issues License

Boolean Attractor Landscape Mapper (biobalm)

biobalm is a Python library for exploring the attractor landscape of large-scale Boolean networks with hundreds or thousands of variables. It combines symbolic (BDD) and automated (ASP) reasoning to efficiently construct a succession diagram of a Boolean network: an inclusion-based acyclic graph of the network's trap spaces. biobalm can then use this succession diagram to accelerate attractor search and infer control strategies for target trap spaces.

biobalm is accompanied by an analysis artefact that benchmarks it against pystablemotifs, mts-nfvs and aeon.py. The artefact also compares the succession diagrams generated by published biological Boolean networks to random network ensembles and finds significant differences in structure. The artefact is available at Zenodo and Github.

Installation

biobalm is on PyPI:

pip install biobalm

The base installation should enable all core functionalities (generate succession diagrams and control strategies, find attractor seeds states and attractor sets). Optionally, you can also use pint during attractor identification as a static analysis step:

  • Native binaries of pint can be obtained here.

You can also install the latest version of biobalm directly from github:

pip install git+https://github.com/jcrozum/biobalm.git@main

Referencing biobalm

biobalm is on bioRxiv:

@article {biobalm,
	author = {Trinh, Van-Giang and Park, Kyu Hyong and Pastva, Samuel and Rozum, Jordan C},
	title = {Mapping the attractor landscape of Boolean networks},
	elocation-id = {2024.09.30.615897},
	year = {2024},
	doi = {10.1101/2024.09.30.615897},
	publisher = {Cold Spring Harbor Laboratory},
	URL = {https://www.biorxiv.org/content/early/2024/10/02/2024.09.30.615897},
	eprint = {https://www.biorxiv.org/content/early/2024/10/02/2024.09.30.615897.full.pdf},
	journal = {bioRxiv}
}

Using biobalm

To learn more about how biobalm functions, API documentation is available online. You can also explore the analysis artefact mentioned above for more in-depth examples of biobalm usage.

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

biobalm-0.4.2.tar.gz (67.0 kB view details)

Uploaded Source

Built Distribution

biobalm-0.4.2-py3-none-any.whl (79.0 kB view details)

Uploaded Python 3

File details

Details for the file biobalm-0.4.2.tar.gz.

File metadata

  • Download URL: biobalm-0.4.2.tar.gz
  • Upload date:
  • Size: 67.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for biobalm-0.4.2.tar.gz
Algorithm Hash digest
SHA256 c8273b28908d1dbd1c881120d0e38494ec65e4cc2a371ab51fca3e28ab05b576
MD5 bed197150633e19172c1c8d8052418d7
BLAKE2b-256 a1e5e004dcb829a25cbb63bcaa9731b38b7f13ff76ef27504830fb59543494cd

See more details on using hashes here.

Provenance

The following attestation bundles were made for biobalm-0.4.2.tar.gz:

Publisher: upload-to-pypi.yml on jcrozum/biobalm

Attestations:

File details

Details for the file biobalm-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: biobalm-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 79.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for biobalm-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b7ba8a7a901fcc695d5b7dbb7aa0f9b91889e2bc59908a43b8a3ab38541f4ddf
MD5 cddc715cd7a3af8e0e405a440e682558
BLAKE2b-256 e66b82ae055a68b58b74402d33b35d203189608aaa375165a8d7b5fbf7deefd3

See more details on using hashes here.

Provenance

The following attestation bundles were made for biobalm-0.4.2-py3-none-any.whl:

Publisher: upload-to-pypi.yml on jcrozum/biobalm

Attestations:

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