Metadata-Version: 2.4
Name: neura-library
Version: 0.4.2
Summary: Utility tools for system neuroscience research, including Open Source Wrapper or Parser
Author-email: Yu-Ting Wei <ytsimon2004@gmail.com>, Ta-Shun Su <antoniost29@gmail.com>
License: BSD 3-Clause License
        
        Copyright (c) 2023, YT.WEI
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Project-URL: Homepage, https://github.com/ytsimon2004/neuralib
Project-URL: Documentation, https://neuralib.readthedocs.io/en/latest/index.html
Project-URL: Repository, https://github.com/ytsimon2004/neuralib
Project-URL: Issues, https://github.com/ytsimon2004/neuralib/issues
Keywords: Neuroscience,visual neuroscience,cellular imaging,brain mapping,spatial navigation
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering
Classifier: Intended Audience :: Science/Research
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: attrs
Requires-Dist: colorama
Requires-Dist: colorlog
Requires-Dist: matplotlib
Requires-Dist: matplotlib_venn
Requires-Dist: seaborn
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: scikit-image
Requires-Dist: pandas
Requires-Dist: polars
Requires-Dist: pyarrow
Requires-Dist: tifffile
Requires-Dist: opencv-python>=4.8.0.76
Requires-Dist: tqdm
Requires-Dist: requests
Requires-Dist: gdown
Requires-Dist: rich
Requires-Dist: h5py
Requires-Dist: typing_extensions
Provides-Extra: atlas
Requires-Dist: brainrender; extra == "atlas"
Requires-Dist: pynrrd; extra == "atlas"
Requires-Dist: openpyxl; extra == "atlas"
Requires-Dist: anytree; extra == "atlas"
Requires-Dist: plotly; extra == "atlas"
Provides-Extra: scanner
Requires-Dist: xmltodict; extra == "scanner"
Requires-Dist: aicspylibczi; extra == "scanner"
Provides-Extra: imaging
Requires-Dist: scanimage-tiff-reader; extra == "imaging"
Requires-Dist: sbxreader; extra == "imaging"
Requires-Dist: ruamel.yaml; extra == "imaging"
Requires-Dist: numba; extra == "imaging"
Requires-Dist: bokeh; extra == "imaging"
Requires-Dist: napari; extra == "imaging"
Provides-Extra: imagelib
Requires-Dist: pdf2image; extra == "imagelib"
Requires-Dist: imageio; extra == "imagelib"
Provides-Extra: rastermap
Requires-Dist: rastermap; extra == "rastermap"
Provides-Extra: cascade
Requires-Dist: tensorflow; extra == "cascade"
Provides-Extra: segmentation
Requires-Dist: pyqt6; extra == "segmentation"
Requires-Dist: pyqtgraph; extra == "segmentation"
Requires-Dist: csbdeep; extra == "segmentation"
Requires-Dist: roifile; extra == "segmentation"
Requires-Dist: napari; extra == "segmentation"
Provides-Extra: cellpose
Requires-Dist: torch; extra == "cellpose"
Requires-Dist: cellpose; extra == "cellpose"
Requires-Dist: neura-library[segmentation]; extra == "cellpose"
Provides-Extra: stardist
Requires-Dist: stardist; extra == "stardist"
Requires-Dist: neura-library[segmentation]; extra == "stardist"
Requires-Dist: numpy<2.0; extra == "stardist" and extra == "stardist"
Provides-Extra: slack
Requires-Dist: dotenv; extra == "slack"
Requires-Dist: slackclient; extra == "slack"
Provides-Extra: gspread
Requires-Dist: gspread; extra == "gspread"
Provides-Extra: opt
Requires-Dist: psutil; extra == "opt"
Provides-Extra: all
Requires-Dist: neura-library[atlas]; extra == "all"
Requires-Dist: neura-library[scanner]; extra == "all"
Requires-Dist: neura-library[imaging]; extra == "all"
Requires-Dist: neura-library[imagelib]; extra == "all"
Requires-Dist: neura-library[rastermap]; extra == "all"
Requires-Dist: neura-library[cascade]; extra == "all"
Requires-Dist: neura-library[cellpose]; extra == "all"
Requires-Dist: neura-library[slack]; extra == "all"
Requires-Dist: neura-library[gspread]; extra == "all"
Requires-Dist: neura-library[opt]; extra == "all"
Provides-Extra: dev
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: neura-library[all]; extra == "dev"
Provides-Extra: doc
Requires-Dist: sphinx; extra == "doc"
Requires-Dist: nbsphinx; extra == "doc"
Requires-Dist: sphinx-toolbox; extra == "doc"
Requires-Dist: sphinx-rtd-theme; extra == "doc"
Requires-Dist: neura-library[all]; extra == "doc"
Dynamic: license-file

# neuralib

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/neura-library)](https://pypi.org/project/neura-library/)
[![PyPI version](https://badge.fury.io/py/neura-library.svg)](https://badge.fury.io/py/neura-library)
[![Downloads](https://static.pepy.tech/badge/neura-library)](https://pepy.tech/project/neura-library)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
[![Documentation Status](https://readthedocs.org/projects/neuralib/badge/?version=latest)](https://neuralib.readthedocs.io/en/latest/)

---

**neuralib** is a utility toolkit for rodent systems neuroscience research. It provides wrappers, parsers, and tools for
efficient data handling, analysis, and reproducibility in open-source neuroscience workflows.

---

## Features

- Open-source parser and wrapper utilities tailored for rodent neuroscience experiments
- Lightweight and modular design for easy integration
- Ready-to-use examples and interactive notebooks
- Clean documentation and API reference

---

## Documentation

- **[Full Documentation](https://neuralib.readthedocs.io/en/latest/index.html)**
- **[Installation Guide](https://neuralib.readthedocs.io/en/latest/api/installation.html)**
- **[Example Notebooks](https://neuralib.readthedocs.io/en/latest/index.html#notebook-example)**

---

## Installation

```bash
pip install neura-library
