Skip to main content

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

Project description

minian logo

pytest status codecov conda version documentation status

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. Install the pipeline notebooks: minian-install --notebooks
  4. Optional install the demo movies: minian-install --demo
  5. Fire up jupyter: jupyter notebook and open the notebook "pipeline.ipynb"

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.

Project details


Download files

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

Source Distribution

minian-1.3.0.tar.gz (106.5 kB view details)

Uploaded Source

Built Distribution

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

minian-1.3.0-py3-none-any.whl (112.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for minian-1.3.0.tar.gz
Algorithm Hash digest
SHA256 bfc7e781228b148d8a004c1692fa239773a1a7754795ee3b536e955e969aca77
MD5 3045c1a572b91afcb5aa4c86b5d22343
BLAKE2b-256 7f6851db8ad7658172b58ac8b0c36dc23b37d877c2bd0e2e7311a44fdbda263b

See more details on using hashes here.

Provenance

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

File metadata

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

File hashes

Hashes for minian-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fcf672950d4c95f715f5a9fc2240bc134bef2133d1e2ba682ce8c62b0b07cbf9
MD5 db1040ec994ce334383355ceb9ceff77
BLAKE2b-256 ee16decec8d9ffc3299b6735b43964a00c13558ba2751c994e73e24e82ff0da9

See more details on using hashes here.

Provenance

The following attestation bundles were made for minian-1.3.0-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 Pingdom Monitoring Sentry Error logging StatusPage Status page