OS/X installation guide

Myokit needs GCC, Python, and the Sundials ODE solvers to run. Each step of the installation is discussed separately below.

Installing the dependencies

The following components are required to run Myokit:

The GCC compiler

First, if you haven't already, install Xcode and the Xcode Command Line Tools to obtain GCC. These can be obtained at developer.apple.com (you may need to create an account).

Sundials

Next, you need to install Sundials, either manually, or (much easier) via homebrew.

To use homebrew, first install it, then install Sundials by opening the terminal and typing

$ brew install sundials

or

$ brew install homebrew-science/sundials

Python

Myokit requires Python (2.7, or 3.4+) to run, including the popular modules NumPy, SciPy, SymPy, lxml, Matplotlib and PyQT (either PyQt4, PyQt5, or PySide).

Most of these packages will automatically be installed when you install Myokit (see below), but the PyQt package may require some work.

One easy way to install it, is to use the Anaconda Python distribution, and install it with the default options.

Alternatively, Python 3 users can install PyQt5 using pip, see below.

If you're using Python 2.7, which is the standard version pre-installed on many Macs, you can install PyQt5 via homebrew:

$ brew install pyqt5

Installing Myokit

To install Myokit, run

$ pip install myokit

Or use the longer form of the same command:

$ python -m pip install myokit

To also install a GUI component, use either

$ pip install myokit[pyqt]

or

$ pip install myokit[pyside]

Once installed, try running a simulation using

$ python -m myokit run example

To run Myokit's IDE, type:

$ python -m myokit ide

To upgrade an existing Myokit installation, use

$ pip install --upgrade myokit

Adding OpenCL support

If you want to use the OpenCL based libraries, look here for instructions.

Uninstall

To uninstall Myokit, use

pip uninstall myokit

Python, Sundials, etc. will need to be uninstalled separately.

Licensing

Please note: GCC, Xcode, Sundials, Python etc. are not part of Myokit, and come with their own user licenses.

Further questions

If you have any questions, please email Michael Clerx (michael@myokit.org) or check out the issues page.