comet-toolbox 0.0.1

Dynamic functional connectivity toolbox for multiverse analysis

Comet - A dynamic functional connectivity toolbox for multiverse analysis

Please note: This package is at a very 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.

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:

1. Download/clone the repository
2. Open a terminal in the folder which contains the pyproject.toml file
3. Install the package via pip (or pip3, depending on your environment)
4. 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

Outlook

The toolbox is under active development, with various features being underway, e.g.:

• Addition of state-based dFC methods
• Multiverse analysis within the GUI
• Visualization of results

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.