Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Add Frites section for information theoretic connectivity #71

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ it can be incorporated into the `main` branch.
To help developing `mne-connectivity`, you will need a few adjustments to your
installation as shown below.

# What Methods Warrant Inclusion in MNE-Connectivity?

With emerging packages, such as `Frites`, MNE-Connectivity aims to be a platform
for enabling other connectivity-based packages that leverage the MNE API. As such, we will not be able to include every single connectivity method possible.
As a rule of thumb (borrowed from scikit-learn), we will accept PRs for methods
that are accepted in the community and tested already through multiple publications.

## Running tests

### (Optional) Install development version of MNE-Python
Expand Down
9 changes: 9 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,15 @@ Li as part of Google Summer of Code 2021. Subsequently v0.1 and v0.2 releases
were done as part of GSoC period. Future development will occur in subsequent
versions.

MNE-Connectivity aims to contain the standard implementations of connectivity
analysis that the community has accepted. `Frites`_ is a Python package that also
implements connectivity methods with the MNE API/framework. For more recent and
new information-theoretic research-geared methods, see `Frites`_ for a
possible implementation.

Although this is a subjective standard, we are open to discussion.
Please see our `contributing guide`_ for more information.

Documentation
^^^^^^^^^^^^^

Expand Down
1 change: 1 addition & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,7 @@
'nilearn': ('http://nilearn.github.io/stable', None),
'dipy': ('https://dipy.org/documentation/1.4.0./',
'https://dipy.org/documentation/1.4.0./objects.inv/'),
'frites': ('https://brainets.github.io/frites/', None),
}
intersphinx_timeout = 5

Expand Down
7 changes: 7 additions & 0 deletions examples/information-theoretic/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Information-Theoretic Examples
------------------------------

.. note::
Examples demonstrating connectivity analysis with information theory are found
in a downstream package
`frites <https://github.com/brainets/frites>`_ package.