User guide

Welcome to BioDynaMo

This user guide is designed to provide documentation for people who will use BioDynaMo on a day-to-day basis, and it aims at providing any user with all essential information to make full use of BDM, starting from a smooth installation all the way to the first succesful simulations. 

This document is designed to be read by any user, as most users will have access to the features documented here, be aware though that developers and contributors instructions (e.g. setting up the developing environment, familiarizing with our CICD pipeline, code of conduct in our spaces, etc...) are covered in a separate section of the guide.

Without any further ado, let’s begin!


This manual is meant to contain all essential information for the user to make full use of BioDynaMo (i.e. it includes a description of the system functions and capabilities, contingencies and alternate modes of operation, and step-by-step procedures for setup and use). 

However, we are a small team and the community of users is very diverse. It can thus happen that some required information, or even some outdated instructions, slip past our attention causing an harsher experience than desirable. Please, cut us some slack and bring whatever defect of desireable improvement up to our attention, on the forum, or on Discord

THANK YOU  for your understanding and support ^_^