Skip to content

Latest commit

 

History

History
195 lines (129 loc) · 5.77 KB

README.rst

File metadata and controls

195 lines (129 loc) · 5.77 KB
Raw
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 manuscript:

Mayner WGP, Marshall W, Albantakis L, Findlay G, Marchman R, Tononi G (2017). PyPhi: A toolbox for integrated information. arXiv:1712.09644 [q-bio.NC].

The manuscript is available at https://arxiv.org/abs/1712.09644.

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 (2017). PyPhi: A toolbox for integrated information. arXiv:1712.09644 [q-bio.NC].

@article{mayner2017pyphi,
  title={PyPhi: A toolbox for integrated information},
  author={Mayner, William, Gerald Paul AND Marshall, William AND 
          Albantakis, Larissa AND Findlay, Graham AND 
          Marchman, Robert AND Tononi, Giulio},
  journal={arXiv:1712.09644 [q-bio.NC]},
  year={2017},
  month={12},
  url={https://arxiv.org/abs/1712.09644}
}

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:
        Integrated Information Theory 3.0},
    author={Albantakis, Larissa AND Oizumi, Masafumi AND Tononi, Giulio},
    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.