Skip to content
main
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Ubuntu unit tests OSX unit tests Windows unit tests Windows Miniconda test codecov Documentation Status

Myokit

Myokit is an open-source Python-based toolkit that facilitates modeling and simulation of cardiac cellular electrophysiology. It's hosted on GitHub and available on PyPi. For the latest documentation, see myokit.readthedocs.io.

More information, including examples and an installation guide, is available on myokit.org. A list of changes introduced in each Myokit release is provided in the Changelog.

Install

For full installation details (on linux, mac, or windows), please see http://myokit.org/install. A shorter installation guide for experienced users is given below.

To install Myokit, using PyQt5 for Myokit's GUI components, run:

pip install myokit[pyqt]

to use PySide2 instead, run:

pip install myokit[pyside]

If you're not planning to use the GUI components (for example to run simulations on a server), you can simply install with

pip install myokit

On Linux and Windows, start menu icons can be added by running

python -m myokit icons

To run single-cell simulations, CVODES must be installed (but Windows users can skip this step, as binaries are included in the pip install). In addition, Myokit needs a working C/C++ compiler to be present on the system.

Existing Myokit installations can be upgraded using

pip install --upgrade myokit

Quick-start guide

After installation, to quickly test if Myokit works, type

python -m myokit run example

or simply

myokit run example

To open an IDE window, type

myokit ide

To see what else Myokit can do, type

myokit -h

Contributing to Myokit

You can contribute to Myokit by reporting issues, but code contributions (bugfixes, new formats, new features etc.) are also very welcome! New features are best discussed in an issue before starting any implementation work, and guidelines for code style (and more) can be found in CONTRIBUTING.md.

Citing Myokit

If you use Myokit in your research, please cite it using the information in our CITATION file.

Research notice

Please note that this repository is participating in a study into sustainability of open source projects. Data will be gathered about this repository for approximately the next 12 months, starting from June 8th 2021.

Data collected will include number of contributors, number of PRs, time taken to close/merge these PRs, and issues closed.

For more information, please visit the informational page or download the participant information sheet.