Skip to main content

Open-source cross-platform biology simulator analyzing gene regulatory networks (GRNs) with Network Finite State Machines (NFSMs).

Project description

Cellnition continuous integration (CI) status

Cellnition is an open source simulator to create and analyze Network Finite State Machines (NFSMs) from gene regulatory network (GRN) models.

Regulatory networks such as GRNs preside over complex phenomena in biological systems, yet given a specific regulatory network, how do we know what it’s capable of doing?

Cellnition treats regulatory networks as analogue computers, where NFSMs map the sequential logic inherent in the network as a dissipative dynamic system. As an extension and improvement upon attractor landscape analysis, NFSMs reveal the analogue computing operations inherent in GRNs, allowing for identification of associated “intelligent behaviors”. NFSMs capture the “analog programming” of GRNs, providing clear identification of:

  • Interventions that can induce transitions between stable states (e.g. from “diseased” to “healthy”)

  • Identification of path-dependencies, representing stable changes occurring after a transient intervention is applied (e.g. evaluating if a transient treatment with pharmacological agent can permanently heal a condition)

  • Identification of inducible cycles of behavior that take the system through a complex multi-phase process (e.g. wound healing).

NFSMs have a range of applications, including the identification of strategies to renormalize cancer (see Tutorial 2).

Read more about Cellnition’s NFSMs in our pre-print publication: Harnessing the Analogue Computing Power of Regulatory Networks with the Regulatory Network Machine.

Cellnition is portably implemented in Python, continuously stress-tested via GitHub Actions × tox × pytest × Codecov, and licensed under a non-commercial use, open source APACHE license with Tufts Open Source License Rider v.1. For maintainability, cellnition officially supports only the most recently released version of CPython.


Install

Cellnition is easily installable with pip, the standard package installer officially bundled with Python:

pip3 install cellnition

Features

Cellnition embodies a range of functionality, including:

  • Work with regulatory networks imported from Cellnition’s network-library, use Cellnition to procedurally generate regulatory networks with random or scale-free degree distributions, or import your own user-defined regulatory networks as directed graphs with activating or inhibiting edge characteristics (see Tutorial 1 and Tutorial 2 for some examples).

  • Analyze and characterize regulatory network graphs with a variety of metrics (see the characterize_graph method and Tutorial 1 and Tutorial 2).

  • Use directed graph representations of regulatory networks to build fully-continuous, differential equation based simulators of network dynamics (see ProbabilityNet class and Tutorial 1).

  • Use directed graph representations of regulatory networks to build logic equation based Boolean simulators of network dynamics (see BooleanNet class and Tutorial 2).

  • Explore regulatory network dynamics with comprehensive equillibrium state search and characterization capabilities, along with temporal simulators (see Tutorial 1 and Tutorial 2 for some examples).

  • Create simulated datasets, including simulation of automated gene-knockout experiments for a continuous regulatory network model (see GeneKnockout class).

  • Generate Network Finite State Machines (NFSMs) for continuous models (see Tutorial 1) or for Boolean models (see Tutorial 2).

  • Create and export a variety of plots and visualizations, including of the regulatory network analytic equations, regulatory network directed graphs, heatmaps of gene expressions in equilibrium states, gene expressions in temporal simulations, and depictions of the general and event-driven NFSMs (see Tutorial 1 and Tutorial 2 for some examples).

Tutorials

Cellnition tutorials are available as Jupyter Notebooks:

  • Tutorial 1 : Create NFSMs from a continuous, differential-equation based GRN model.

  • Tutorial 2 : Create NFSMs from a Boolean, logic-equation based GRN model.

License

Cellnition is non-commerical use, open source software licensed under an Apache 2.0 license with Tufts Open Source License Rider v.1, restricting use to academic purposes only.

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

cellnition-0.2.0.tar.gz (269.8 kB view details)

Uploaded Source

Built Distribution

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

cellnition-0.2.0-py3-none-any.whl (240.6 kB view details)

Uploaded Python 3

File details

Details for the file cellnition-0.2.0.tar.gz.

File metadata

  • Download URL: cellnition-0.2.0.tar.gz
  • Upload date:
  • Size: 269.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for cellnition-0.2.0.tar.gz
Algorithm Hash digest
SHA256 c404da6b6f1432a1ed1b65610db1e77e432e894b35ca699e4dc62146fd8311ba
MD5 e81c5b2c24f9c72f80a18417897fa230
BLAKE2b-256 7f8d5af36787a2aa6fe7a87df33b9e7afa76698444ce6b57f9d60f599d7aae2f

See more details on using hashes here.

Provenance

The following attestation bundles were made for cellnition-0.2.0.tar.gz:

Publisher: python_release.yml on betsee/cellnition

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

File details

Details for the file cellnition-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: cellnition-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 240.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for cellnition-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 71dc63b912efa236260583e1f580df081b9bc914e97f1d15dca3813836ccf8a8
MD5 27afce2fc155ae68d1ce2c2a824b3311
BLAKE2b-256 3507296db9905871f7df8f8a1505baf4ccee44db927e05f58fc7b9023aed1e6f

See more details on using hashes here.

Provenance

The following attestation bundles were made for cellnition-0.2.0-py3-none-any.whl:

Publisher: python_release.yml on betsee/cellnition

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