Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
mtorabi59 authored Nov 28, 2023
1 parent c918a76 commit 2b6c217
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.10161177.svg
:target: https://doi.org/10.5281/zenodo.10161177

dFC
pydfc
=======
An implementation of several well-known dynamic Functional Connectivity assessment methods.
An implementation of several well-known dynamic Functional Connectivity (dFC) assessment methods.

Simply do these steps in the main repository directory to learn how to use the dFC functions:
* ``conda create --name multi_analysis_dfc_env python=3.8.5``
* ``conda activate multi_analysis_dfc_env``
* ``conda create --name pydfc_env python=3.11``
* ``conda activate pydfc_env``
* ``pip install -e '.'``
* run the code cells in demo jupyter notebooks

The ``dFC_methods_demo.ipynb`` illustrates how to load data and apply each of the implemented dFC methods individually.
The ``multi_analysis_demo.ipynb`` illustrates how to use the ``multi_analysis_dfc`` toolbox to apply multiple dFC methods at the same time on a dataset and compare their results.
The ``dFC_methods_demo.ipynb`` illustrates how to load data and apply each of the dFC methods implemented in the ``pydfc`` toolbox individually.
The ``multi_analysis_demo.ipynb`` illustrates how to use the ``pydfc`` toolbox to apply multiple dFC methods at the same time on a dataset and compare their results.

For more details about the implemented methods and the comparison analysis see `our paper <https://www.biorxiv.org/content/10.1101/2023.07.13.548883v2>`_.

Expand Down

0 comments on commit 2b6c217

Please sign in to comment.