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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

minian-2.0.1.tar.gz (1.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

minian-2.0.1-py3-none-any.whl (1.4 MB view details)

Uploaded Python 3

File details

Details for the file minian-2.0.1.tar.gz.

File metadata

  • Download URL: minian-2.0.1.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for minian-2.0.1.tar.gz
Algorithm Hash digest
SHA256 c1f4437ccec8ba9abe88974c4a45f1b94aa26ce9bcc013ed6571c40423f9bf0e
MD5 9f30ac2ffe7270df4f124dd9d5195f79
BLAKE2b-256 3b56caff86821a6ece1cd9a3847f111288b26d217bca7f182f8c5a104067c41a

See more details on using hashes here.

Provenance

The following attestation bundles were made for minian-2.0.1.tar.gz:

Publisher: publish.yml on miniscope/minian

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file minian-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: minian-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 1.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for minian-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7c658321258ed9f23888c7a0b6a839a3bf49daaf6b6030f4a917400ce86a90bd
MD5 1205665fd5b272f16e33ad17f2d83951
BLAKE2b-256 636ac8bcf46f95a232de2416fafbc4c6c6e907bc0d09bdb72366c1bbb75959a5

See more details on using hashes here.

Provenance

The following attestation bundles were made for minian-2.0.1-py3-none-any.whl:

Publisher: publish.yml on miniscope/minian

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page