SysSynBio / tissue-forge

Interactive, particle-based physics, chemistry and biology modeling and simulation environment

Tissue Forge

Tissue Forge is an interactive, particle-based physics, chemistry and biology modeling and simulation environment. Tissue Forge provides the ability to create, simulate and explore models, simulations and virtual experiments of soft condensed matter physics at multiple scales using a simple, intuitive interface. Tissue Forge is designed with an emphasis on problems in complex subcellular, cellular and tissue biophysics. Tissue Forge enables interactive work with simulations on heterogeneous computing architectures, where models and simulations can be built and interacted with in real-time during execution of a simulation, and computations can be selectively offloaded onto available GPUs on-the-fly.

Tissue Forge is a native compiled C++ shared library that's designed to be used for model and simulation specification in compiled C++ code. Tissue Forge includes extensive C, C++ and Python APIs and additional support for interactive model and simulation specification in an IPython console and a Jupyter Notebook. Tissue Forge currently supports installations on 64-bit Windows, Linux and MacOS systems.

Build Status

Binaries

The latest Tissue Forge developments are archived at the Tissue Forge Azure project.

Platform	Status
Linux
MacOS
Windows

Documentation

Tissue Forge documentation is available online,

Document	Link	Status
Tissue Forge Documentation	link
C++ API Documentation	link
Python API Documentation	link
C API Documentation	link

Installation

Pre-Built Binaries

Binary distributions of Tissue Forge are available via conda from the tissue-forge channel,

conda install -c conda-forge -c tissue-forge tissue-forge

Pre-built binaries of the latest Tissue Forge developments are also archived at the Tissue Forge Azure project. Installing pre-built binaries requires Miniconda. Binaries on Linux require the Mesa packages libgl1-mesa-dev and libegl1-mesa-dev. Packages include a convenience script install_env that installs the dependencies of the Tissue Forge installation on execution. After installing the dependencies environment, the Tissue Forge installation can be used after executing the following steps from a terminal with the root of the installation as the current directory.

On Windows

call etc/vars
conda activate %TFENV%

On Linux and MacOS

source etc/vars.sh
conda activate $TFENV

Launching the provided Python examples are then as simple navigating to the tissue_forge Python module and then executing the following,

python examples/cell_sorting.py

Likewise, Tissue Forge can be imported in Python scripts and interactive consoles,

import tissue_forge as tf

From Source

Supported installation from source uses Git and Miniconda for building and installing most dependencies. In addition to requiring Git and Miniconda, installation from source on Windows requires Visual Studio 2019 Build Tools, on Linux requires the Mesa packages libgl1-mesa-dev and libegl1-mesa-dev, and on MacOS requires Xcode with 10.9 SDK or greater.

To execute the standard installation, open a terminal in a directory to install Tissue Forge and clone this respository,

git clone --recurse-submodules https://github.com/tissue-forge/tissue-forge

From the directory containing the tissue-forge root directory, perform the following.

On Windows

call tissue-forge/package/local/install

On Linux

bash tissue-forge/package/local/install.sh

On MacOS, specify the installed MacOS SDK (e.g., for 10.9)

export TFOSX_SYSROOT=10.9
bash tissue-forge/package/local/install.sh

The standard installation will create the directories tissue-forge_build and tissue-forge_install next to the tissue-forge root directory, the former containing the build files, and the latter containing the installed binaries and conda environment. The source and build directories can be safely deleted after installation. The conda environment will be installed in the subdirectory env. To activate the conda environment with the Tissue Forge Python module, perform the following.

On Windows

call tissue-forge_install/etc/vars
conda activate %TFENV%

On Linux and MacOS

source tissue-forge_install/etc/vars.sh
conda activate $TFENV

Launching the provided Python examples are then as simple as the following

python tissue-forge/py/examples/cell_sorting.py

Likewise Tissue Forge can be imported in Python scripts and interactive consoles

import tissue_forge as tf

Customizing the Build

Certain aspects of the installation can be readily customized. The source directory tissue-forge/package/local contains subdirectories linux, osx and win containing scripts install_vars.sh and install_vars.bat for Linux/MacOS and Windows, respectively, which declare default installation environment variables. These environment variables can be customized to specify where to find, build and install Tissue Forge, as well as the build configuration. For example, to install Tissue Forge from a source directory MYTFSRC, build Tissue Forge at path MYTFBUILD in debug mode and install into directory MYTFINSTALL, perform the following.

On Windows

call %MYTFSRC%/package/local/win/install_vars
set TFBUILD_CONFIG=Debug
set TFSRCDIR=%MYTFSRC%
set TFBUILDDIR=%MYTFBUILD%
set TFINSTALLDIR=%MYTFINSTALL%
call %TFSRCDIR%/package/local/win/install_env
conda activate %TFENV%
call %TFSRCDIR%/package/local/win/install_all

On Linux

source $MYTFSRC/package/local/linux/install_vars.sh
export TFBUILD_CONFIG=Debug
export TFSRCDIR=$MYTFSRC
export TFBUILDDIR=$MYTFBUILD
export TFINSTALLDIR=$MYTFINSTALL
bash ${TFSRCDIR}/package/local/linux/install_env.sh
conda activate $TFENV
bash ${TFSRCDIR}/package/local/linux/install_all.sh

On MacOS

source $MYTFSRC/package/local/osx/install_vars.sh
export TFBUILD_CONFIG=Debug
export TFSRCDIR=$MYTFSRC
export TFBUILDDIR=$MYTFBUILD
export TFINSTALLDIR=$MYTFINSTALL
bash ${TFSRCDIR}/package/local/osx/install_env.sh
conda activate $TFENV
bash ${TFSRCDIR}/package/local/osx/install_all.sh

The default Python version of the installation is 3.7, though Tissue Forge has also been tested on Windows, Linux and MacOS for Python versions 3.8 and 3.9. To specify a different version of Python, simply add a call to update the conda environment in the previous commands before calling install_all.

Enabling Interactive Tissue Forge

Tissue Forge supports interactive modeling and simulation specification in an IPython console and Jupyter Notebook. To enable interactive Tissue Forge in an IPython console, activate the installed environment as previously described and install the ipython package from the conda-forge channel,

conda install -c conda-forge ipython

To enable interactive Tissue Forge in a Jupyter Notebook, activate the installed environment as previously described and install the notebook, ipywidgets and ipyevents packages from the conda-forge channel,

conda install -c conda-forge notebook ipywidgets ipyevents