dsb-lab / CellBasedModels.jl

Julia package for multicellular modeling
MIT License
18 stars 3 forks source link

CellBasedModels.jl

Stable Dev

You can find the documentation here!

The CellBasedModels.jl package aims to help fast-designing and simulation of agent-based models with possibilities to be run in CPU and NVidia GPUs for the efficient computation of large-scale systems.

The following methods can be implemented in the model:

Check the Examples to get an idea of the capabilities of the package.

Installation

You can install the package from the official repositories as:

julia> using Pkg
julia> Pkg.add("CellBasedModels")

or you can install the developer version from Github as:

julia> using Pkg
julia> Pkg.add("https://github.com/dsb-lab/CellBasedModels.jl")

Alternatively, you can install it from the Pkg REPL:

] add CellBasedModels
] add https://github.com/dsb-lab/CellBasedModels.jl

Docker

There are available docker images that already have everything installed with the packages you may need to execute simulations out-of-the-box.

For more information see this section

Examples

Patterning ICM Development Particle Aggregation Bacterial Colony Growth Bacterial Chemotaxis

Current Limitations

At the present stage of development, the library is not capable of working on batches of data. That means that the size of the simulated models will be limited by the memory disponibility in RAM or the GPU, depending on the platform in which the simulations are being tested.

Moreover, we can only use GPUs from NVidia as the GPU implementation is based on CUDA.jl.

Future work

We intend to extend the current version of the package with additional capabilities. Any help is welcome!

Short term

Long term goals