Dynamic functional connectivity toolbox for multiverse analysis
Project description
Comet - A dynamic functional connectivity toolbox for multiverse analysis
Important notes:
- This package is at an early stage of development, with frequent changes being made. If you intend to use this package at this stage, I kindly ask that you contact me via the email address in the pyproject.toml file.
- Many features are not yet tested, so there will be bugs (the question is just how many). A comprehensive testing suite and documentation will be added in the near future
- The GUI still has many bugs, so using the scripting API is recommended for now
Current Features
Installation
Installation is possible through the Python Package Index (PyPI) with the pip or pip3 command, depending on your system:
pip install comet-toolbox
We further recommend using a dedicated Anaconda or Miniconda environment to mitigate the risk of potential version conflicts.
Installation from the source code of this repository is also possible:
- Download/clone the repository
- Open a terminal in the folder which contains the pyproject.toml file
- Install the package via pip (or pip3, depending on your environment)
- If you intend to implement your own modification, installing in editable mode (-e) is a helpful approach
pip install -e .
Usage
GUI
After installation, you can use the graphical user interface through the terminal by typing:
comet-gui
If you want to explore the toolbox with example data, you can load the src/comet/resources/simulation.txt
file which should result in two changing connectivity patterns.
Scripting
If you intend to use the toolbox in a standard python script, demo scripts are provided as a starting point:
- Demo script for calculating dFC: click here
- Demo script for performing multiverse analysis: click here
- Demo script for the multiverse analysis as presented preprint (+ additional visualizations): click here
Feedback and contribution
If you have any wishes, suggestions, feedback, or encounter any bugs, please don't hesitate to contact me via email or create an issue here. Contributions or future collaboration are also welcome.
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
Built Distribution
Hashes for comet_toolbox-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4c9ab725c97a8d3c5f02aa7e0b339969d4052871c7e1bdf211d977470aa78e67 |
|
MD5 | bba2804d565d14f138c612ad4ab91568 |
|
BLAKE2b-256 | 21ab9c3503d9627a8cc93300178df31a937a2aacd23fbd48a332e8c2aac0ad84 |