Metadata-Version: 2.1
Name: myokit
Version: 1.30.3
Summary: A simple interface to cardiac cellular electrophysiology
Home-page: http://myokit.org
Author: Michael Clerx
Author-email: michael@myokit.org
License: BSD 3-clause license
Description: [![travis](https://travis-ci.com/MichaelClerx/myokit.svg?branch=master)](https://travis-ci.com/MichaelClerx/myokit)
        [![appveyor](https://ci.appveyor.com/api/projects/status/u2e6bc6tklgxyyra/branch/master?svg=true)](https://ci.appveyor.com/project/MichaelClerx/myokit)
        [![codecov](https://codecov.io/gh/MichaelClerx/myokit/branch/master/graph/badge.svg)](https://codecov.io/gh/MichaelClerx/myokit)
        [![Documentation Status](https://readthedocs.org/projects/myokit/badge/?version=latest)](https://myokit.readthedocs.io/?badge=latest)
        
        ![Myokit](http://myokit.org/static/img/logo.png)
        
        [Myokit](http://myokit.org) is an [open-source](https://github.com/MichaelClerx/myokit/blob/master/LICENSE.txt) Python-based toolkit that facilitates modeling and simulation of cardiac cellular electrophysiology.
        It's hosted on [GitHub](https://github.com/MichaelClerx/myokit/) and available on [PyPi](https://pypi.org/project/myokit/).
        For the latest documentation, see [myokit.readthedocs.io](https://myokit.readthedocs.io/).
        
        More information, including examples and an installation guide, is available on [myokit.org](http://myokit.org).
        
        
        ## Install
        
        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, [CVODE](https://computation.llnl.gov/projects/sundials/sundials-software) 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
        
        For full details, see [http://myokit.org/install](http://myokit.org/install).
        
        ## 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
        
        
        ## Citing Myokit
        
        If you use Myokit in your research, please cite it using the information in our [CITATION file](./CITATION).
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
Provides-Extra: pyside
Provides-Extra: docs
Provides-Extra: gui
Provides-Extra: dev
Provides-Extra: pyqt
Provides-Extra: optional
