Installation

This package is intended for installation within an existing CaImAn conda environment. Please refer to the CaImAn installation instructions to set up this environment.

• For Windows users new to CaImAn, see the PDF guide Note on CaImAn setup on Windows for step-by-step installation instructions.
• For macOS users new to CaImAn, see the PDF guide Note on CaImAn setup on macOS for step-by-step installation instructions.

Do not install Pluvianus outside of the CaImAn environment!

From distribution

• To install Pluvianus from PyPI, run the following command in your already set up CaImAn environment:

  pip install pluvianus
  

From Source

Steps:

1. Clone the repository:

   git clone https://github.com/katonage/pluvianus.git
   

2. Navigate to the pluvianus directory:

   cd pluvianus
   

3. Install Pluvianus in editable mode into your CaImAn environment:

   pip install -e .
   

System Requirements

• Refer to CaImAn's system requirements: CaImAn Installation
• At least an HD display is recommended.
• Windows, Linux, and macOS 13 or higher are supported.

Tested on

• Windows 11, Anaconda3.
• macOS 26, Anaconda3 (macOS 12 is not compatible with the used QT version)
• CaImAn 1.11.4 - 1.13.1
• PySide6 6.9.2 - 6.10.2 (With PySide 6.9.1 the application freezes.)

See also

• Usage
• TOC