openCARP examples

These examples are intended to transfer basic user know-how regarding most openCARP features in an efficient way. The scripts are designed as mini-experiments, which can also serve as basic building blocks for more complex experiments. This example can be a good starting point to base your own experiment on.

There is a number of examples dedicated to teaching openCARP fundamental know-how for those who are interested in building more complex experiments from scratch themselves or in extending pre-existing experiments. All executable examples are coded up in carputils to facilitate an easy execution of all experiments without significant additional effort and complex command line interactions.

Do you want to improve the existing examples or contribute an additional one? We provide instructions in the experiments repository.

Intended use

Most examples can be run by simply copying the command from the corresponding example web page. It is recommended to inspect the generated command lines to understand what the simulation looks like in the plain command line by adding the option --dry to the run script command line. You can download the examples from our repository.

Electrophysiology in single cell

The following examples illustrate how single cell modeling is performed using the tool bench. Additionally you learn how to integrate a single cell model from CellML into our library limpet using the math language EasyML

Monodomain and bidomain tissue models

These examples inform about basic steps in developing tissue simulations based on the monodomain and bidomain models

Simple carputils example

Simple carputils example

This is not a real example but more of a template to base your own experiment on. It covers mesh generation, monodomain simulation and local activation time extraction during postprocessing.

Basic tissue EP: AP propagation

Basic tissue EP: AP propagation

This example introduces to the basics of using the openCARP executable for simulating EP at the tissue and organ scale.

Extracellular stimulation

Extracellular stimulation

In this example you learn how to stimulate a tissue from the extracellular space.

Ionic model parameter adjustment to match APD

Ionic model parameter adjustment to match APD

This example demonstrates how to adjust ionic model parameters to generate a specific action potential duration in your simulations.

Tuning conduction velocity

Tuning conduction velocity

This example introduces the background for the relationship between conduction velocity and tissue conductivity.

Limit cycle initialization; cell to tissue state transfer

Limit cycle initialization; cell to tissue state transfer

This example demonstrates how to initialize a cardiac tissue with state variables obtained from a single-cell stimulation.

Model parameter adjustment to match wavelength

Model parameter adjustment to match wavelength

This example demonstrates how to adjust parameters in tissue simulations to match experimental data for conduction velocity, APD, and wavelength.

Conduction velocity restitution

Conduction velocity restitution

This example demonstrates how to compute conduction velocity (CV) restitution in cardiac tissue.

ERP restitution

ERP restitution

This example shows how to calculate the effective refractory period (ERP) for a given combination of ionic conductances in a tissue slab using an S1S2 pacing protocol. An ERP restitution curve can also be plotted, if desired by the user.

Niederer et al. benchmark: numerical discretization

Niederer et al. benchmark: numerical discretization

This example replicates the Niederer et al. benchmark and illustrates effects of some numerical settings including temporal and spatial discretization.

Region tagging

Region tagging

Regions are used to manage the assignment of heterogeneous tissue properties. This example explains the different approches of how regions can be defined.

Heterogeneity: conductivity regions

Heterogeneity: conductivity regions

This example details how to assign different conductivities to different parts of a simulated tissue slice using region-wise tagging.

Heterogeneity: ionic model regions

Heterogeneity: ionic model regions

This example details how to assign different single cell dynamics to different parts of a simulated tissue slice using region-wise tagging.

Heterogeneities: regions vs. gradiensts (nodal adjustment)

Heterogeneities: regions vs. gradiensts (nodal adjustment)

This example introduces the concepts of region-based and gradient-based heterogeneities for assigning spatially varying properties.

Heterogeneities: smooth gradients via nodal adjustments of ionic model parameters

Heterogeneities: smooth gradients via nodal adjustments of ionic model parameters

This example details how to assign a gradient of single cell properties using the adjustments interface.

Output spatio-temporal state variable distributions

Output spatio-temporal state variable distributions

This example details how to output the values of state variables over time during a simulation.

Electrical mapping (LAT)

Electrical mapping (LAT)

This example demonstrates how to compute local activation times (LATs) and action potential durations (APDs) of cells in a cardiac tissue during the simulation rather than during postprocessing.

Extracellular potentials and ECGs

Extracellular potentials and ECGs

This example explains the background of computing extracellular potentials and ECG using different techniques.

Periodic boundary conditions

Periodic boundary conditions

Periodic boundary conditions connect the left edge of a sheet to the right, or the top to the bottom.

Local activation time

Local activation time

This example demonstrates how to compute local activation times (LATs) and action potential durations (APDs) of cells in a cardiac tissue

Laplace solutions

Laplace solutions

Computing Laplace-Dirichlet maps provide an elegant tool for describing the distance between defined boundaries.

Unequal anisotropy effects

Unequal anisotropy effects

Unequal anisotropy ratios in bidomain simulations can be responsible for the formation of unexpectedly complex polarization patterns.

Parameter sweeps

Parameter sweeps

This example shows how to use polling files to sweep parameters.

Reentry induction protocols

Reentry induction protocols

This example shows the influence of different induction protocol on reentry initiation and maintenance.

ForCEPSS: VARP Protocol

ForCEPSS: VARP Protocol

This example demonstrates the usage of ForCEPSS implementation of the VARP (Virtual Arrhythmia Risk Predictor) protocols in the context of cardiac electrophysiology simulations.

Eikonal-based tissue models

These examples inform about basic steps in developing tissue simulations based on the eikonal, reaction-eikonal and DREAM models

Visualization

Learn how to use the visualization tools LimpetGUI for single cell results as well as Meshalyzer and ParaView for tissue results

Pre- and post-processing

Learn how to use the meshing tools and how to postprocess igb files

© Copyright 2020 openCARP project    Supported by DFG and EuroHPC    Contact    Imprint and data protection