Python library for computing integrated information.
Project description
.. raw:: html
<a href="http://pyphi.readthedocs.io/en/latest/"><img alt="PyPhi logo" src="https://github.com/wmayner/pyphi/raw/develop/docs/_static/pyphi-logo-text-760x180.png" height="90px" width="380px" style="max-width:100%;"></a>
|
.. image:: https://img.shields.io/badge/DOI-10.5281%20%2F%20zenodo.636912-blue.svg?style=flat-square&maxAge=86400
:target: https://doi.org/10.5281/zenodo.636912
:alt: Zenodo DOI badge
.. image:: https://readthedocs.org/projects/pyphi/badge/?version=latest&style=flat-square&maxAge=600
:target: https://pyphi.readthedocs.io/en/latest/?badge=latest
:alt: Documentation badge
.. image:: https://img.shields.io/travis/wmayner/pyphi.svg?style=flat-square&maxAge=600
:target: https://travis-ci.org/wmayner/pyphi
:alt: Travis build badge
.. image:: https://img.shields.io/coveralls/wmayner/pyphi/develop.svg?style=flat-square&maxAge=600
:target: https://coveralls.io/github/wmayner/pyphi?branch=develop
:alt: Coveralls.io badge
.. image:: https://img.shields.io/github/license/wmayner/pyphi.svg?style=flat-square&maxAge=86400
:target: https://github.com/wmayner/pyphi/blob/master/LICENSE.md
:alt: License badge
.. image:: https://img.shields.io/pypi/pyversions/pyphi.svg?style=flat-square&maxAge=86400
:target: https://wiki.python.org/moin/Python2orPython3
: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
<http://dx.doi.org/10.1371/journal.pcbi.1003588>`_.
To cite the code, use the Zenodo DOI for the verison you used. The latest one
is `10.5281/zenodo.636912 <http://dx.doi.org/10.5281/zenodo.636912>`_.
For example::
Mayner, William GP et al. (2017). PyPhi: 0.9.0. Zenodo. 10.5281/zenodo.636912
Or in BibTeX::
@misc{pyphi,
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 = {http://dx.doi.org/10.5281/zenodo.636912}
}
(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
<http://pyphi.readthedocs.io/en/stable/>`_, or the `documentation for the
latest (potentially unstable) development version
<http://pyphi.readthedocs.io/en/latest/>`_.
The documentation is also available within the Python interpreter with the
``help`` function.
Installation
~~~~~~~~~~~~
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+https://github.com/wmayner/pyphi@develop#egg=pyphi"
**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
appreciated!
Detailed installation guide for Mac OS X
````````````````````````````````````````
`See here <https://github.com/wmayner/pyphi/blob/develop/INSTALLATION.md>`_.
Discussion
~~~~~~~~~~
For technical issues with PyPhi or feature requests, please use the `issues
page <https://github.com/wmayner/pyphi/issues>`_.
For discussion about the software or integrated information theory in general,
you can join the `PyPhi users group
<https://groups.google.com/forum/#!forum/pyphi-users>`_.
Contributing
~~~~~~~~~~~~
To help develop PyPhi, fork the project on GitHub and install the requirements
with
.. 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
Credits
~~~~~~~
This code is based on a `previous project <https://github.com/albantakis/iit>`_
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 `albantakis@wisc.edu
<mailto:albantakis@wisc.edu>`_.
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
<http://www.ploscompbiol.org/article/info%3Adoi%2F10.1371%2Fjournal.pcbi.1003588>`_.
PLoS Comput Biol 10(5): e1003588. doi: 10.1371/journal.pcbi.1003588
.. code:: latex
@article{iit3,
author = {Albantakis, , Larissa AND Oizumi, , Masafumi AND Tononi, ,
Giulio},
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 = {http://dx.doi.org/10.1371%2Fjournal.pcbi.1003588},
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
<a href="http://pyphi.readthedocs.io/en/latest/"><img alt="PyPhi logo" src="https://github.com/wmayner/pyphi/raw/develop/docs/_static/pyphi-logo-text-760x180.png" height="90px" width="380px" style="max-width:100%;"></a>
|
.. image:: https://img.shields.io/badge/DOI-10.5281%20%2F%20zenodo.636912-blue.svg?style=flat-square&maxAge=86400
:target: https://doi.org/10.5281/zenodo.636912
:alt: Zenodo DOI badge
.. image:: https://readthedocs.org/projects/pyphi/badge/?version=latest&style=flat-square&maxAge=600
:target: https://pyphi.readthedocs.io/en/latest/?badge=latest
:alt: Documentation badge
.. image:: https://img.shields.io/travis/wmayner/pyphi.svg?style=flat-square&maxAge=600
:target: https://travis-ci.org/wmayner/pyphi
:alt: Travis build badge
.. image:: https://img.shields.io/coveralls/wmayner/pyphi/develop.svg?style=flat-square&maxAge=600
:target: https://coveralls.io/github/wmayner/pyphi?branch=develop
:alt: Coveralls.io badge
.. image:: https://img.shields.io/github/license/wmayner/pyphi.svg?style=flat-square&maxAge=86400
:target: https://github.com/wmayner/pyphi/blob/master/LICENSE.md
:alt: License badge
.. image:: https://img.shields.io/pypi/pyversions/pyphi.svg?style=flat-square&maxAge=86400
:target: https://wiki.python.org/moin/Python2orPython3
: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
<http://dx.doi.org/10.1371/journal.pcbi.1003588>`_.
To cite the code, use the Zenodo DOI for the verison you used. The latest one
is `10.5281/zenodo.636912 <http://dx.doi.org/10.5281/zenodo.636912>`_.
For example::
Mayner, William GP et al. (2017). PyPhi: 0.9.0. Zenodo. 10.5281/zenodo.636912
Or in BibTeX::
@misc{pyphi,
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 = {http://dx.doi.org/10.5281/zenodo.636912}
}
(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
<http://pyphi.readthedocs.io/en/stable/>`_, or the `documentation for the
latest (potentially unstable) development version
<http://pyphi.readthedocs.io/en/latest/>`_.
The documentation is also available within the Python interpreter with the
``help`` function.
Installation
~~~~~~~~~~~~
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+https://github.com/wmayner/pyphi@develop#egg=pyphi"
**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
appreciated!
Detailed installation guide for Mac OS X
````````````````````````````````````````
`See here <https://github.com/wmayner/pyphi/blob/develop/INSTALLATION.md>`_.
Discussion
~~~~~~~~~~
For technical issues with PyPhi or feature requests, please use the `issues
page <https://github.com/wmayner/pyphi/issues>`_.
For discussion about the software or integrated information theory in general,
you can join the `PyPhi users group
<https://groups.google.com/forum/#!forum/pyphi-users>`_.
Contributing
~~~~~~~~~~~~
To help develop PyPhi, fork the project on GitHub and install the requirements
with
.. 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
Credits
~~~~~~~
This code is based on a `previous project <https://github.com/albantakis/iit>`_
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 `albantakis@wisc.edu
<mailto:albantakis@wisc.edu>`_.
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
<http://www.ploscompbiol.org/article/info%3Adoi%2F10.1371%2Fjournal.pcbi.1003588>`_.
PLoS Comput Biol 10(5): e1003588. doi: 10.1371/journal.pcbi.1003588
.. code:: latex
@article{iit3,
author = {Albantakis, , Larissa AND Oizumi, , Masafumi AND Tononi, ,
Giulio},
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 = {http://dx.doi.org/10.1371%2Fjournal.pcbi.1003588},
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
Release history Release notifications | RSS feed
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)
Built Distribution
pyphi-0.9.0-py3-none-any.whl
(652.3 kB
view hashes)