A Python package for computing integrated information.
Clone or download
Latest commit 1431ae9 Sep 10, 2018
Permalink
Failed to load latest commit information.
benchmarks Rename `compute.big_phi()` to `compute.phi()` Dec 18, 2017
docs docs/conf.py: Update copyright year Aug 15, 2018
paper Add PLOS Computational Biology paper to repo Aug 14, 2018
profiling Don't use `format` with logging Jun 12, 2017
pyphi Fix Numpy element-wise comparision deprecation Sep 10, 2018
test Fix Redis cache fixture Sep 10, 2018
.coveragerc Disable coverage for parallel code Sep 16, 2017
.flake8 Add `.flake8` configuration Jun 5, 2017
.gitignore Ignore `.tox` Jan 21, 2018
.isort.cfg Add `.isort.cfg` Jan 2, 2018
.pylintrc Pylint: remove redundant directives Apr 23, 2018
.travis.yml Travis: pin NumPy to 1.14.5 Sep 10, 2018
CACHING.rst Move caching section in README to separate file Mar 23, 2017
CHANGELOG.md Update CHANGELOG May 30, 2018
INSTALLATION.rst INSTALLATION.rst: Fix link to examples Mar 20, 2018
LICENSE.md Add GNUv3 license Apr 7, 2014
MANIFEST.in Convert README to markdown May 30, 2018
Makefile Makefile: clean-dist: Use `rm -rf` May 30, 2018
README.md README.md: Update PyPhi paper citation Aug 15, 2018
conftest.py Redis: use a test database Apr 26, 2018
dev_requirements.txt dev_requirements.txt: Specify versions for dist May 30, 2018
pyphi_config.yml Remove `LOG_CONFIG_ON_IMPORT` option Apr 28, 2018
pytest.ini Rename `unpartitioned_ces` to `ces` Dec 18, 2017
redis.conf Clean up `redis.conf` Feb 7, 2016
requirements.txt Revert "Tweak requirements order" Mar 8, 2018
setup.cfg Add setup.cfg Dec 12, 2014
setup.py Support Python 3.7 Jul 15, 2018
test_requirements.txt Require pytest>=3.10 Sep 10, 2018
tox.ini Add `tox.ini` Jan 21, 2018

README.md

PyPhi logo

Documentation badge Travis build badge Coveralls.io badge License badge Python versions badge

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

If you use this code, please cite the paper:


Mayner WGP, Marshall W, Albantakis L, Findlay G, Marchman R, Tononi G. (2018) PyPhi: A toolbox for integrated information theory. PLOS Computational Biology 14(7): e1006343. https://doi.org/10.1371/journal.pcbi.1006343


Usage, Examples, and API documentation

Installation

Set up a Python 3 virtual environment and install with

pip install pyphi

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

pip install "git+https://github.com/wmayner/pyphi@develop#egg=pyphi"

Note: this software is only supported on Linux and macOS. However, if you use Windows, you can run it by using the Anaconda Python distribution and installing PyPhi with conda:

conda install -c wmayner pyphi

Detailed installation guide for Mac OS X

See here.

User group

For discussion about the software or integrated information theory in general, you can join the pyphi-users group.

For technical issues with PyPhi or feature requests, please use the issues page.

Contributing

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

pip install -r requirements.txt

The Makefile defines some tasks to help with development:

make test

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

make benchmark

runs performance benchmarks.

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:

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

Credit

Please cite these papers if you use this code:

Mayner WGP, Marshall W, Albantakis L, Findlay G, Marchman R, Tononi G. (2018) PyPhi: A toolbox for integrated information theory. PLOS Computational Biology 14(7): e1006343. https://doi.org/10.1371/journal.pcbi.1006343

@article{mayner2018pyphi,
  title={PyPhi: A toolbox for integrated information theory},
  author={Mayner, William GP and Marshall, William and Albantakis, Larissa and Findlay, Graham and Marchman, Robert and Tononi, Giulio},
  journal={PLoS Computational Biology},
  volume={14},
  number={7},
  pages={e1006343},
  year={2018},
  publisher={Public Library of Science},
  doi={10.1371/journal.pcbi.1006343},
  url={https://doi.org/10.1371/journal.pcbi.1006343}
}

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.

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

This project is inspired by a previous project written in Matlab by L. Albantakis, M. Oizumi, A. Hashmi, A. Nere, U. Olces, P. Rana, and B. Shababo.

Correspondence regarding this code and the PyPhi paper should be directed to Will Mayner, at mayner@wisc.edu. Correspondence regarding the Matlab code and the IIT 3.0 paper should be directed to Larissa Albantakis, PhD, at albantakis@wisc.edu.