Skip to content

PhysiBoSS_CreateInitTxtFile

Arnau Montagud edited this page Oct 2, 2019 · 2 revisions

PhysiBoSS_CreateInitTxtFile executable

Executable to create a txt file containing cells positions and sizes, ready to be used as initial condition of a simulation.

This executable is created in the bin folder after compilation. It allows the user to directly create an initial configuration file correctly formatted to be used in a simulation. It reads an input XML file (init.xml by default) containing the configuration choices (sphere, rectangle, cylinder...) and create the init.txt file in output. Thus different initial conditions can be easily automatically created.

Usage

To create the initial file, call 'PhysiBoSS_CreateInitTxtFile' executable from a Terminal window. The XML file to read (init.xml) containing the user choices can be precised as argument of the command.

The file init.xml (or spheroid.xml here in the example below) contained two parts: the description of active cells initial geometry and sizes, and the description of eventual passive cells. An example of such configuration file is given in the release and also shown in the example below.

Command:

path_to_physiboss/bin/PhysiBoSS_CreateInitTxtFile file spheroid.xml

Current Possibilities

In the current version, 3 geometries are proposed: spheric (mode=0), cylindric (mode=1) or rectangles (mode=2). The created shape is centered around (0,0,0) but this can be very easily modified in the source code. Active and/or passive cells can be placed in those geometries. The mean radius of cells can be precised, as well as the dimensions of the geometries (sphere radius, cylinder length and radius, rectangle width and length). If 2 cell types are present the proportion to which the first cell type should be initialised can be precised with cell_proportion parameter.

Example

Example of the init configuration file spheroid.xml:

<?xml version="1.0" encoding="UTF-8" ?>

<active_cells> <mode> 0 </mode> <cell_radius> 9.5 </cell_radius> <length> 100 </length> <cell_spacing> 0.95 </cell_spacing> </active_cells>

<passive_cells> <mode> 0 </mode> <cell_radius> 10 </cell_radius> <length> 150 </length> <min_length> 100 </min_length> <cell_spacing> 1 </cell_spacing> </passive_cells>

With this file, we created a spheroid of radius 100 µm, composed of cells with a mean radius of 9.5 µm, and spaced with 0.95 of their size (or 95%, small overlap). The spheroid is surrounded by a spheric extra-cellular matrix, with a radius of 150 µm (but empty in the 100 µm internal sphere) represented by passive cells of mean radius 10 µm.

Todo:
Add more options of configurations (more geometries, distributions of cell size and phases...).
Author
G. Letort, Institut Curie
Date
June 2017