Skip to main content

A simple interface to cardiac cellular electrophysiology

Project description

Ubuntu unit tests MacOS 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.

I like to keep track of who's using Myokit (for my CV!). If you are using Myokit for teaching, I'd love to hear about it. You can drop me a line at michael[at]myokit.org.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

myokit-1.35.3.tar.gz (3.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

myokit-1.35.3-py3-none-any.whl (4.0 MB view details)

Uploaded Python 3

File details

Details for the file myokit-1.35.3.tar.gz.

File metadata

  • Download URL: myokit-1.35.3.tar.gz
  • Upload date:
  • Size: 3.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for myokit-1.35.3.tar.gz
Algorithm Hash digest
SHA256 c1d32eaa1938d852cfe84f7efc19759f853402b84b798c6865901978e74f7b75
MD5 66b79f87968102d95c50cf5ce4262968
BLAKE2b-256 01ed5475a560df813220098345f13588f7f4d61c537cefab12cbdfd56ec73ec9

See more details on using hashes here.

File details

Details for the file myokit-1.35.3-py3-none-any.whl.

File metadata

  • Download URL: myokit-1.35.3-py3-none-any.whl
  • Upload date:
  • Size: 4.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for myokit-1.35.3-py3-none-any.whl
Algorithm Hash digest
SHA256 224c73f37d787b68514b702d70f7c6e7aba9fff8caff14071677e934334c2fa4
MD5 590c692b57b8d26ff377a5686ea0ab98
BLAKE2b-256 5ca9ab8032aa99fefb943ff6d1c97c62f690333f14f2d5fee6abb2a5b59bdf8e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page