Metadata-Version: 2.4
Name: mbo_utilities
Version: 1.0.2
Summary: Various utilities for the Miller Brain Observatory
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://github.com/millerbrainobservatory/mbo_utilities
Project-URL: Documentation, https://millerbrainobservatory.github.io/mbo_utilities/index.html
Project-URL: Repository, https://github.com/millerbrainobservatory/mbo_utilities
Project-URL: Issues, https://github.com/MillerBrainObservatory/mbo_utilities/issues
Keywords: Microscopy,ScanImage,multiROI,Tiff
Requires-Python: <3.13,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: tifffile>=2025.3.30
Requires-Dist: scikit-image
Requires-Dist: zarr>=2.18.3
Requires-Dist: dask>=2025.3.0
Requires-Dist: imageio[ffmpeg]
Requires-Dist: ffmpeg-python
Requires-Dist: matplotlib>=3.10.1
Requires-Dist: h5py
Requires-Dist: tqdm
Requires-Dist: imgui-bundle==1.6.3
Requires-Dist: jupyter_rfb>=0.5.1
Requires-Dist: fastplotlib>=0.5.0
Requires-Dist: jupyterlab>=4.5.0a0
Requires-Dist: ipykernel
Requires-Dist: ipywidgets<9,>=8.0.0
Requires-Dist: icecream>=2.1.4
Requires-Dist: glfw
Provides-Extra: napari
Requires-Dist: napari; extra == "napari"
Provides-Extra: docs
Requires-Dist: sphinx>=6.1.3; extra == "docs"
Requires-Dist: docutils>=0.19; extra == "docs"
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: numpydoc; extra == "docs"
Requires-Dist: ipykernel; extra == "docs"
Requires-Dist: sphinx-autodoc2; extra == "docs"
Requires-Dist: sphinx_tippy; extra == "docs"
Requires-Dist: sphinx_gallery; extra == "docs"
Requires-Dist: sphinx-togglebutton; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Requires-Dist: sphinx_book_theme; extra == "docs"
Requires-Dist: sphinx_design; extra == "docs"
Requires-Dist: sphinxcontrib-images; extra == "docs"
Requires-Dist: sphinxcontrib-video; extra == "docs"
Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
Requires-Dist: jupytext; extra == "docs"
Requires-Dist: myst_nb; extra == "docs"
Requires-Dist: scipy; extra == "docs"
Requires-Dist: scikit-image; extra == "docs"
Requires-Dist: suite2p_mbo; extra == "docs"
Requires-Dist: cellpose; extra == "docs"
Provides-Extra: all
Requires-Dist: napari; extra == "all"
Requires-Dist: pytest; extra == "all"
Requires-Dist: ruff; extra == "all"
Requires-Dist: sphinx>=6.1.3; extra == "all"
Requires-Dist: docutils>=0.19; extra == "all"
Requires-Dist: nbsphinx; extra == "all"
Requires-Dist: numpydoc; extra == "all"
Requires-Dist: ipykernel; extra == "all"
Requires-Dist: sphinx-autodoc2; extra == "all"
Requires-Dist: sphinx_tippy; extra == "all"
Requires-Dist: sphinx_gallery; extra == "all"
Requires-Dist: sphinx-togglebutton; extra == "all"
Requires-Dist: sphinx-copybutton; extra == "all"
Requires-Dist: sphinx_book_theme; extra == "all"
Requires-Dist: sphinx_design; extra == "all"
Requires-Dist: sphinxcontrib-images; extra == "all"
Requires-Dist: sphinxcontrib-video; extra == "all"
Requires-Dist: sphinxcontrib-bibtex; extra == "all"
Requires-Dist: jupytext; extra == "all"
Requires-Dist: myst_nb; extra == "all"
Requires-Dist: scipy; extra == "all"
Requires-Dist: scikit-image; extra == "all"
Requires-Dist: suite2p_mbo; extra == "all"
Requires-Dist: cellpose; extra == "all"
Dynamic: license-file

# MBO Utilities

General Python and shell utilities developed for the Miller Brain Observatory (MBO) workflows.

[![Documentation](https://img.shields.io/badge/Documentation-black?style=for-the-badge&logo=readthedocs&logoColor=white)](https://millerbrainobservatory.github.io/mbo_utilities/)

Most functions have examples in docstrings.

Converting scanimage tiffs into intermediate filetypes for preprocessing or to use with Suite2p is covered [here](https://millerbrainobservatory.github.io/mbo_utilities/assembly.html).

Function examples [here](https://millerbrainobservatory.github.io/mbo_utilities/api/usage.html) are a work in progress.

---

## Installation

This package is fully installable with `pip`.

`conda` can still be used for the virtual environment, but be mindful to only install packages with `conda install` when absolutely necessary.

``` bash
# make sure your environment is activated, be that conda, venv, uv venv (stick to these)
pip install mbo_utilities
```

To get the latest version:

```bash
pip install git+https://github.com/MillerBrainObservatory/mbo_utilities.git@master
```

---

## Acknowledgements

Thank you to the developers of [scanreader](https://github.com/atlab/scanreader) and the broader open-source community.
