Skip to main content

minian logo

pytest status codecov pypi version python versions conda version documentation status DOI

license code style commit style

MiniAn

MiniAn is an analysis pipeline and visualization tool inspired by both CaImAn and MIN1PIPE package specifically for Miniscope data.

Prerequisites

  • FFmpeg (ffmpeg and ffprobe on PATH for video I/O)

Quick Start Guide

  1. (Recommended) Create and activate a fresh environment, e.g. python -m venv minian-env && source minian-env/bin/activate or conda create -y -n minian && conda activate minian
  2. Install MiniAn, either:
    • with pip: pip install minian (install FFmpeg separately, see Prerequisites), or
    • from conda-forge: conda install -y -c conda-forge minian (includes FFmpeg)
  3. Copy the pipeline notebook into your working directory: minian notebooks copy pipeline
  4. Fire up jupyter and open it: jupyter notebook minian-notebooks/pipeline/pipeline.ipynb

The notebook downloads its demo recording automatically on first run (cached and checksum-verified). Browse and manage the bundled notebooks with minian notebooks list and the demo datasets with minian data list. See the command line interface reference for all commands and options.

Documentation

MiniAn documentation is hosted on ReadtheDocs at:

https://minian.readthedocs.io/

Contributing to MiniAn

We would love feedback and contribution from the community! See the contribution page for more detail!

License

This project is licensed under GNU GPLv3.

Metadata

Release files for minian 2.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for minian 2.0.2
File Size Uploaded
minian-2.0.2.tar.gz 1.4 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for minian 2.0.2
File Interpreter ABI Platform
minian-2.0.2-py3-none-any.whl Python 3 none any Details

Total release size: 2.8 MB

Release files / minian-2.0.2.tar.gz

Download URL minian-2.0.2.tar.gz
Size 1.4 MB
Tags Source
SHA-256 checksum
How to use checksums
2b4ee1325172abb024723330575cdeb83b19de06ff8f9e21270ff2a78f6056d4
BLAKE2b-256 checksum
How to use checksums
5d1a42189d5fa776c0b367d70bf7a188c2f4f796d6e88f4c37392e744df4b959
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 26, 2026.

Transparency log

Release files / minian-2.0.2-py3-none-any.whl

Download URL minian-2.0.2-py3-none-any.whl
Size 1.4 MB
Tags Python 3
SHA-256 checksum
How to use checksums
4c08e0b128ecf193e7d3f5096aa21d6459ea1f24932fe8240cc72c1fb91479da
BLAKE2b-256 checksum
How to use checksums
168050592a616965508cd394d9d6a6daa4c22e8608f97a66f3061d310ce5b206
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 26, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

2.0.2 This release

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.3.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page