Packages

Here are the packages with brief descriptions (if available):

[detail level 123]

▼Nbin
NAPDrestitution	Plot APD restitution curve as generated with bench
Nbin2h5	Create a HDF5 repository file for the ionic models in LIMPET
Nbsa	Determine body surface area (BSA) in [m^2] from weight W [kg] and height [cm]
Nbuild_pathway
Nbullseye	Generate a bullseye plot for given data
Ncarphelp	OpenCARP parameters helper
Ncarptests
Ncavplot	Plot pressure and volume traces and PV loops from a cvsys simulation
Nclosest_hc
Ncuclean	Clean the output of openCARP examples in the example repositories using the carptests framework
Ncusettings	Generate or update a carputils settings file
Ncusummary	Print carputils settings summary to the console
Necgplotter	Read an igb file containing extracellular potentials recorded for a 12-lead ECG
Nep_init	Limit cycle experiment
NgenerateMetadata
Nigb_to_vtkhdf
NigbPlotter	Plot data from an igb file
Ninsert_endo_layer
Nj2c	Translate json dictionaries into carp* command line
Nklotz	Determine Klotz curve from (EDV,EDP) pair
Nlimit_cycle
Nlut2hdf5	Convert lookup tables to HDF5, for use in limpetGUI
NmeshQstats	Read in a given mesh and compute mesh quality statistics
Nparfile2carputils
NplotTrace	Plot trace files
NrestituteCV	Read in a given mesh and matching activation time data to compute conduction velocity vectors
Nstrainplotter	Plot strains from an igb file containing strain data
Nsurfextract	Little tool to extract surface data from a given mesh and save them as VTK files
Nsv2hdf5	Convert state variable files to HDF5, for use in limpetGUI
Nsvgecg2txt	Converts single ECG trace in Inkscape SVG format to text format
Ntissue_calibrate	Tissue experiment velocity and conductivity tuning
Ntrfm
NtuneCV	Tune conductivity settings to match prescribed conduction velocities
NtuneCV3
Ntxt2h5	Create a HDF5 repository file for the ionic models in LIMPET
Ntxtecg2json	Read CARDIOPROOF ecg traces (.txt file) and convert them into json format
Nupdate-carp
Nvelocity	Read in a given mesh and matching activation time data to compute conduction velocity vectors
▼Ncarputils
Nbench	Some tools for interfacing with the bench executable
►Nbullseye	Bullseye plot generation
Nplot
Nretag
►Nbundle	This module implements the bundle feature, which allows to easily share carputils experiments
Nbundle
Nbundleinclude
Nbundleio	File and folder manipulation utilities for the bundle feature
Nmetadata
Nparfileadjustment	Functions to adjust an openCARP parameter file to be included in a bundle
Npath_utils	Path manipulation utilities for the bundle feature
Nrelease	(Deprecated) Utility functions for RADAR releases of bundles
Nupload
►Ncarpio	Each module in this package defines a class for reading and writing a specific data type
Nbin	Provides a class for bench .bin file IO to/from python numpy arrays
Ncsv	Read csv files
Nfilelike
Nigb	Provides a class for IGB IO to/from python numpy arrays
Nlimpetguihdf5
Nlut	Read binary lookup tables into python numpy arrays
Nmeshtool
Nmsh_stats
Nquantity	Provides a class to convert physical quantities from a string to numerical values
Nsv	Functionality to read/write state variable (sv) files
Ntagdefs	Provides a class for .dat and .vec IO to/from python numpy arrays
Ntxt	Provides a class for .dat and .vec IO to/from python numpy arrays
Ncext
Nclean	Functions for cleaning directories and manage overwrite behavior
Ncli	Some argparse extensions implementing custom behaviors for carputils
►Ncml
Ncmlconverter
Ncmlparser
Ncmltree
Ndataproc
Ndebug	Some tools for running jobs in the debugger
Ndebugging	Debugging utilities
Ndivertoutput	Execute external processes with output buffering and error checking
Necg
Nep	Helper tools for setting up electrophysiology simulations
Nfigui
►Nfitting
Nklotz	Implementation from Klotz's paper 'A computational method of prediction of the end-diastolic pressure-volume relationship by single beat'
►Nforcepss
Ncell_limcyc
Nj2carp
Nplanio
Nprepace
Ntissue_limcyc
Nformat	Output formatting utilities
►Njob	This package most importantly defines the :class:~carputils.job.Job class, which provides methods for executing bash commands
Ncommand	Defines several types of commands to execute
Njob
Noptionlist
Nserialise	Serialise and de-serialise and run Python functions
Nlats
►Nmachines	Platform-specific functionality such as MPI launcher generation
Narcher	ARCHER platform script
Narcher2
Narcher24c
Narcher2_e756
Narcher_camel	ARCHER project camel platform script
Narcher_intel	ARCHER intel platform script
Nbwunicluster
Ncurie
Ndesktop
Ngeneral
Nhoreka
Nmarconi
Nmarconi_slurm
Nmedbionode
Nmedtronic
Nmephisto
Nsupermuc
Nvsc2
Nvsc3
Nvsc4
Nvsc5
Nwopr
►Nmesh	Classes and routines for the generation of geometric meshes
Nbase
Nbivslice	Generate a simple bi-ventricular slice geometry, providing a few parameters
Nblock	A class and associated functions for generating geometries with mesher
Ncable
Nellipsoid	Class for generation of an ellipsoidal shell mesh
Nfibres	Functions to assist in setting up fibres in generated meshes
Nfourch	Generate a simple four-chamber like geometry, providing a few parameters
Ngeneral	Base framework for the mesh generation classes
Ngenerate	Function to generate a CARP mesh if it does not yet exist
Ngrid
Npipe	Generate a simple pipe geometry, providing a few parameters
Nregion	Define some region defining objects for use with geometry classes
Nring	Generate a simple ring geometry, providing a few parameters
►Nmodel
Nconductivity
Ngeneral	The core infrastructure of the model component classes
Ngenerate	Code to automatically generate model component classes from the openCARP source
Ngenerate_carpentry	Code to automatically generate model component classes from the CARP source
NinduceReentry	4 different protocols to induce reentry are implemented: "RP_E": Rapid Pacing with activity checking at the End of the protocol; \ "RP_B": Rapid Pacing with activity checking after each Beat; \ "PSD": Phase Singularity Distribution method; \ "PEERP": Pacing at the End of the Effective Refractory Period'
Nionic
Nprepace
Nstimulus
Nplot
Npolling	Functions for generating and executing openCARP polling files
Nprompt	User query functions
Nrestitute	Functions for single-cell APD restitution
Nserialise	Functions for serialising and deserialising datetime and timedelta objects
►Nsettings	This module manages and exposes carputils settings
Nbuildinfo	Load the my_switches.def settings from the CARP repository
Nconfig	Functionality for the parsing of a carputils settings file
Nexceptions
Nnamespace	Implements the SettingsNamespace class, which provides case-insensitive namespaces
Npaths	Path handling utilities, including management of executable paths
Nsettings	SettingsModule class and Exception for global settings object
Nsolver	Generation and management of solver options
Nsummary
Nstates
Nstream	Some tools for handling output streams (stdout, etc.)
Nsvn	SVN utilites
Ntools
Ntuning	Tune conductivity settings to match prescribed conduction velocities
Nrun
Ntest_simple_bundle