Welcome to pcarpet’s documentation!

pcarpet is a small python package that creates a carpet plot from fMRI data and decomposes it with PCA.

Author: Nikoloz Sirmpilatze (German Primate Center)

Citation: Sirmpilatze et al., 2022

For an overview of the project, please refer to the README file in the Github repository.

Contents:

• Rationale
  • How it works
• Installation
  • a. pip
  • b. Anaconda
• Running pcarpet
  • Inputs and initialization
  • Option 1: Running the entire pcarpet pipeline at once
  • Option 2: Running pcarpet step-by-step
  • Outputs
• API
  • Classes
  • Functions