PhysiCOOL: A generalized framework for model Calibration and Optimization Of modeLing projects

PyPI - Python Version GitHub Documentation Status Codecov Code style: black

Overview

Latest tested PhysiCell version: 1.10.4

PhysiCOOL is a Python library tailored to perform model calibration studies with PhysiCell. Using the PhysiCOOL package, PhysiCell projects can be converted into black-box models to characterize how simulation outputs change in response to variations in input values. PhysiCOOL takes advantage of Python’s popularity and simplicity which makes PhysiCell models more accessible and enables users to integrate Python-based calibration tools with their PhysiCell workflows.

Although PhysiCOOL was designed to create full model calibration worfflows, its components can be used independently according to the users’ needs. For instance,this novel package implements a file parser that enables users to read and write data to the PhysiCell XML configuration file using simple Python commands. Data validation is performed when new information is written to the files, assuring that the new values are consistent with PhysiCell’s requirements and assumptions. Furthermore, PhysiCOOL also provides new functions to process and visualize simulation outputs which can be used for both parameter exploration and model calibration.

PhysiCOOL is available through pip using the following command:

pip install physicool

Usage

Getting help

For usage questions, bug reports and suggested improvements, please open a new issue through the GitHub “Issues” tab.

Credits

PhysiCOOL was created with cookiecutter and the py-pkgs-cookiecutter template.