Metadata-Version: 2.1
Name: minian
Version: 1.2.0
Summary: MiniAn is an analysis pipeline and visualization tool inspired by both CaImAn and MIN1PIPE package specifically for Miniscope data.
Home-page: https://github.com/DeniseCaiLab/minian
Author: MiniAn Developers
Author-email: denisecailab@gmail.com
License: UNKNOWN
Project-URL: Documentation, https://minian.readthedocs.io/
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: bokeh (==1.4.0)
Requires-Dist: cvxpy (>=1.1.11)
Requires-Dist: dask (==2021.2.0)
Requires-Dist: datashader (==0.12.1)
Requires-Dist: distributed (==2021.2.0)
Requires-Dist: ecos (>=2.0.7)
Requires-Dist: ffmpeg-python (==0.2.0)
Requires-Dist: holoviews (==1.12.7)
Requires-Dist: jupyter
Requires-Dist: matplotlib
Requires-Dist: natsort
Requires-Dist: netcdf4
Requires-Dist: networkx (==2.4)
Requires-Dist: numba (==0.52.0)
Requires-Dist: numpy (==1.20.2)
Requires-Dist: opencv-python (==4.2.0.34)
Requires-Dist: pandas (==1.2.3)
Requires-Dist: panel (==0.8.0)
Requires-Dist: pyfftw (==0.12.0)
Requires-Dist: scikit-image (==0.18.1)
Requires-Dist: scikit-learn (==0.22.1)
Requires-Dist: scipy (>=1.4.1)
Requires-Dist: scs
Requires-Dist: simpleitk (==2.0.2)
Requires-Dist: sk-video
Requires-Dist: statsmodels (>=0.11.1)
Requires-Dist: tifffile
Requires-Dist: xarray (==0.17.0)
Requires-Dist: zarr
Requires-Dist: sparse (==0.11.2)
Requires-Dist: pymetis (==2020.1)
Requires-Dist: rechunker (==0.3.3)
Requires-Dist: medpy (==0.4.0)

[![pytest status](https://github.com/denisecailab/minian/workflows/pytest/badge.svg?branch=master)](https://github.com/DeniseCaiLab/minian/actions?query=workflow%3Apytest)
[![codecov](https://codecov.io/gh/DeniseCaiLab/minian/branch/master/graph/badge.svg)](https://codecov.io/gh/DeniseCaiLab/minian)
[![conda version](https://img.shields.io/conda/vn/conda-forge/minian.svg)](https://anaconda.org/conda-forge/minian)
[![documentation status](https://readthedocs.org/projects/minian/badge/?version=latest)](https://minian.readthedocs.io/en/latest/?badge=latest)

[![license](https://img.shields.io/github/license/denisecailab/minian)](https://www.gnu.org/licenses/gpl-3.0)
[![code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![commit style](https://img.shields.io/badge/commit_style-conventional-orange)](https://conventionalcommits.org)


# MiniAn

MiniAn is an analysis pipeline and visualization tool inspired by both [CaImAn](https://github.com/flatironinstitute/CaImAn) and [MIN1PIPE](https://github.com/JinghaoLu/MIN1PIPE) package specifically for [Miniscope](http://miniscope.org/index.php/Main_Page) data.

# Quick Start Guide

1. Create a new conda env: `conda create -y --name minian`
1. Activate the environment: `conda activate minian`
1. Install MiniAn: `conda install -y -c conda-forge minian`
1. Install the pipeline notebooks: `minian-install --notebooks`
1. Optional install the demo movies: `minian-install --demo`
1. 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](https://minian.readthedocs.io/en/latest/start_guide/contribute.html) for more detail!

# License

This project is licensed under GNU GPLv3.


