Skip to content

junipertcy/functional-connectivity

Repository files navigation

PythonVersion PyPI Black license

functional-connectivity implements a set of tools to detect and sense changes in a functional network from spike counts

This is the software repository behind the paper:

  • Tzu-Chi Yen and Yi-Yun Ho, Mapping functional neuronal networks to behavioral states, in preparation (2024).

Read it on: arXiv.

  • For full documentation, please visit this site.
  • For general Q&A, ideas, or other things, please visit Discussions.
  • For software-related bugs, issues, or suggestions, please use Issues.

Installation

functional-connectivity is available on PyPI:

pip install functional-connectivity

The dependencies needed to interact with Dandi are not installed by default. You will need to run:

  • pip install --ignore-installed --no-binary=h5py h5py scipy numba

Development

Remember that ./docs contains the documentation of this library. You would need AWS credentials to be able to execute ./docs/deploy.sh.

To install the dependencies, use the following snippets.

pip install toml
python scripts/pyproject2req.py
pip install -r requirements.txt

Acknowledgement

The functional-connectivity library is supported by The Kavli Foundation. TCY wants to thank Rebecca Morrison (@rebeccaem) and Stephen Becker (@stephenbeckr) for inspirations.

We also want to thank the authors in these software implementations:

License

functional-connectivity is open-source and licensed under the GNU Lesser General Public License v3.0.