MiniAn is an analysis pipeline and visualization tool inspired by both CaImAn and MIN1PIPE package specifically for Miniscope data.
- FFmpeg (
ffmpegandffprobeonPATHfor video I/O)
- (Recommended) Create and activate a fresh environment, e.g.
python -m venv minian-env && source minian-env/bin/activateorconda create -y -n minian && conda activate minian - 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)
- with pip:
- Copy the pipeline notebook into your working directory:
minian notebooks copy pipeline - 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.
MiniAn documentation is hosted on ReadtheDocs at:
https://minian.readthedocs.io/
We would love feedback and contribution from the community! See the contribution page for more detail!
This project is licensed under GNU GPLv3.