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.2.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.2-py3-none-any.whl (1.4 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: minian-2.0.2.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.2.tar.gz
Algorithm Hash digest
SHA256 2b4ee1325172abb024723330575cdeb83b19de06ff8f9e21270ff2a78f6056d4
MD5 4c64bcfd1b6b9683bf53f3bac404e659
BLAKE2b-256 5d1a42189d5fa776c0b367d70bf7a188c2f4f796d6e88f4c37392e744df4b959

See more details on using hashes here.

Provenance

The following attestation bundles were made for minian-2.0.2.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.2-py3-none-any.whl.

File metadata

  • Download URL: minian-2.0.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4c08e0b128ecf193e7d3f5096aa21d6459ea1f24932fe8240cc72c1fb91479da
MD5 8a452cb0a844bc623e7c55596bb18e4c
BLAKE2b-256 168050592a616965508cd394d9d6a6daa4c22e8608f97a66f3061d310ce5b206

See more details on using hashes here.

Provenance

The following attestation bundles were made for minian-2.0.2-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