Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

An agent-based framework for the simulation of biological cell systems and more.

Project description

https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg

An agent-based framework for the simulation of biological cell systems.

This was created to simulate cancer growth, taking into account nutrients and cell migration while allowing to track mutations, cell division and cell position history to study tumour phylogeny reconstruction algorithms.

https://raw.githubusercontent.com/Ad115/Cell-System/master/assets/sidebyside.png https://raw.githubusercontent.com/Ad115/Cell-System/master/assets/spacetime.png

Installation

You can install it from PyPI:

$ pip install cellsystem

Example

A use case integrated in the repository:

>>> from cellsystem import *

# The cell system will simulate cell growth
# while tracking the steps in that process.
>>> system = CellSystem(grid_shape=(100, 100))

# Initialize the first cell
# in the middle of the grid
>>> system.seed()


New cell 0 added @ (50, 50)


# Take 35 steps forward in time
>>> system.run(steps=30)


Cell no. 0 mutating @ site (50, 50) (father None)
         Initial mutations: []
                     Initial genome: AAAAAAAAAA
         Final mutations: [(4, 'G')]
                     Final genome: AAAAGAAAAA
Cell no. 0 dividing @ (50, 50)
    New cells: 1 @ (49, 50) and 2 @ (50, 51)
Cell no. 2 dividing @ (50, 51)
    New cells: 3 @ (51, 52) and 4 @ (51, 52)
Cell no. 4 mutating @ site (51, 52) (father 2)
         Initial mutations: [(4, 'G')]
                     Initial genome: AAAAGAAAAA
         Final mutations: [(4, 'G'), (7, 'A')]
                     Final genome: AAAAGAAAAA
Cell no. 1 death @ site (49, 50) (father None)
Cell no. 3 death @ site (51, 52) (father 2)
Cell no. 4 mutating @ site (51, 52) (father 2)
         Initial mutations: [(4, 'G'), (7, 'A')]
                     Initial genome: AAAAGAAAAA
         Final mutations: [(4, 'G'), (7, 'A'), (2, 'T')]
                     Final genome: AATAGAAAAA
Cell no. 4 migrating from site (51, 52) (father 2)
     New site: (50, 52)
...
...
...


# Prepare to explore the simulation logs
>>> history = system['log']


# First, let's see the cells' evolution in time and space!
>>> history.worldlines().show()

# Remove the cells that died somewhere along the way
>>> history.worldlines(prune_death=True).show()
https://raw.githubusercontent.com/Ad115/Cell-System/master/assets/geometry.png https://raw.githubusercontent.com/Ad115/Cell-System/master/assets/geometry_no_death.png
>>> tree_style = {'show_leaf_name' : True,
...               'mode' : 'c',        # Circular
...               'arc_start' : -135,  # Degrees
...               'arc_span' : 270 }   # Degrees also


# Lookup the tree formed by cellular division
>>> history.ancestry().show(styling=tree_style)

# Now, remove cells that are no longer alive
>>> history.ancestry(prune_death=True).show(styling=tree_style)
https://raw.githubusercontent.com/Ad115/Cell-System/master/assets/ancestry.png https://raw.githubusercontent.com/Ad115/Cell-System/master/assets/ancestry_no_death.png
# Now, check out the tree formed by the mutations
>>> history.mutations().show(styling=tree_style)

# Remove genomes with no living representatives.
>>> history.mutations(prune_death=True).show(styling=tree_style)
https://raw.githubusercontent.com/Ad115/Cell-System/master/assets/mutations.png https://raw.githubusercontent.com/Ad115/Cell-System/master/assets/mutations_no_death.png

Almost every aspect of the simulation is customizable. You can add several types of different interacting cell lines, also, worlds with different geometry and with diffusion, cells with other characteristics that can be logged, other kinds of logs. Change the rate of death, movement, etc of each cell and even add new cell behaviors!

For now the documentation for doing so is scattered through the class documentation strings, but a good place to start is by watching the source of the cellsystem.CellSystem class.

Meta

Author: Ad115 - Githuba.garcia230395@gmail.com

Distributed under the MIT license. See LICENSE for more information.

Contributing

  1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
  2. Fork the repository on GitHub to start making your changes to a feature branch, derived from the master branch.
  3. Write a test which shows that the bug was fixed or that the feature works as expected.
  4. Send a pull request and bug the maintainer until it gets merged and published.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
cellsystem-0.4.2-py3-none-any.whl (27.6 kB) Copy SHA256 hash SHA256 Wheel py3

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page