Skip to main content

Python library for computing integrated information.

Project description

.. raw:: html

<a href=""><img alt="PyPhi logo" src="" height="90px" width="380px" style="max-width:100%;"></a>


.. image::
:alt: Zenodo DOI badge

.. image::
:alt: Documentation badge

.. image::
:alt: Travis build badge

.. image::
:alt: badge

.. image::
:alt: License badge

.. image::
:alt: Python versions badge


PyPhi is a Python library for computing integrated information (|phi|), and the
associated quantities and objects.

**If you use this code, please cite it, as well as the** `IIT 3.0 paper

To cite the code, use the Zenodo DOI for the verison you used. The latest one
is `10.5281/zenodo.636912 <>`_.
For example::

Mayner, William GP et al. (2017). PyPhi: 0.9.0. Zenodo. 10.5281/zenodo.636912

Or in BibTeX::

author = {Mayner, William Gerald Paul and
Marshall, William and
Marchman, Bo},
title = {PyPhi: 0.9.0},
month = Feb,
year = 2017,
doi = {10.5281/zenodo.636912},
url = {}

(Just make sure to use the version number, DOI, and URL for the version you
actually used.)

Usage, Examples, and API documentation

Check out the `documentation for the latest stable release
<>`_, or the `documentation for the
latest (potentially unstable) development version

The documentation is also available within the Python interpreter with the
``help`` function.


Set up a Python 3 virtual environment and install with

.. code:: bash

pip install pyphi

To install the latest development version, which is a work in progress and may
have bugs, run:

.. code:: bash

pip install "git+"

**Note:** this software has only been tested on the Mac OS X and Linux
operating systems. Windows is not supported, though it might work with minor
modifications. If you do get it to work, a writeup of the steps would be much

Detailed installation guide for Mac OS X

`See here <>`_.


For technical issues with PyPhi or feature requests, please use the `issues
page <>`_.

For discussion about the software or integrated information theory in general,
you can join the `PyPhi users group


To help develop PyPhi, fork the project on GitHub and install the requirements

.. code:: bash

pip install -r requirements.txt

The ``Makefile`` defines some tasks to help with development:

.. code:: bash

make test

runs the unit tests every time you change the source code.

.. code:: bash

make benchmark

runs performance benchmarks.

.. code:: bash

make docs

builds the HTML documentation.

Developing on Linux

Make sure you install the C headers for Python 3, SciPy, and NumPy before
installing the requirements:

.. code:: bash

sudo apt-get install python3-dev python3-scipy python3-numpy


This code is based on a `previous project <>`_
written in Matlab by L. Albantakis, M. Oizumi, A. Hashmi, A. Nere, U. Olces, P.
Rana, and B. Shababo.

Correspondence regarding the Matlab code and the IIT 3.0 paper (below) should
be directed to Larissa Albantakis, PhD, at `

Please cite this paper if you use this code:

Albantakis L, Oizumi M, Tononi G (2014) `From the Phenomenology to the
Mechanisms of Consciousness: Integrated Information Theory 3.0
PLoS Comput Biol 10(5): e1003588. doi: 10.1371/journal.pcbi.1003588

.. code:: latex

author = {Albantakis, , Larissa AND Oizumi, , Masafumi AND Tononi, ,
journal = {PLoS Comput Biol},
publisher = {Public Library of Science},
title = {From the Phenomenology to the Mechanisms of Consciousness:
Integrated Information Theory 3.0},
year = {2014},
month = {05},
volume = {10},
url = {},
pages = {e1003588},
number = {5},
doi = {10.1371/journal.pcbi.1003588}

.. |phi| unicode:: U+1D6BD .. mathematical bold capital phi
.. |small_phi| unicode:: U+1D6D7 .. mathematical bold phi

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

pyphi-0.9.0.tar.gz (146.5 kB view hashes)

Uploaded Source

Built Distribution

pyphi-0.9.0-py3-none-any.whl (652.3 kB view hashes)

Uploaded Python 3

Supported by

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