Metadata-Version: 2.1
Name: neura-library
Version: 0.0.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.9
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.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: attrs==23.2.0
Requires-Dist: colorama
Requires-Dist: matplotlib
Requires-Dist: seaborn~=0.12.1
Requires-Dist: memory_profiler
Requires-Dist: numpy
Requires-Dist: numba
Requires-Dist: pandas~=1.5.0
Requires-Dist: pyarrow
Requires-Dist: psutil
Requires-Dist: polars>=0.20.9
Requires-Dist: sbxreader
Requires-Dist: scikit-image
Requires-Dist: scipy>=1.12
Requires-Dist: tifffile==2023.4.12
Requires-Dist: tqdm~=4.62.3
Requires-Dist: requests
Requires-Dist: rich
Requires-Dist: typing_extensions
Requires-Dist: gspread~=5.7.2
Requires-Dist: opencv-python~=4.8.0.76


# neuralib

[![Document Status](https://readthedocs.org/projects/neuralib/badge/?version=latest)](https://neuralib.readthedocs.io/en/latest/index.html)
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/ytsimon2004/neuralib)

- Utility tools for system neuroscience research, including Open Source Wrapper or Parser

## Installation

- `pip install neura-library` in your conda env with Python >= 3.9
- According to purpose, install the optional package [requirements-optional.txt](requirements-optional.txt)

## Usage

## See to [Doc](https://neuralib.readthedocs.io/en/latest/index.html)

### argp

- `neuralib.argp`: Use argparse as dataclass field

### atlas

- Module for whole brain, slice view visualization and rois classification
- `neuralib.atlas.ccf`: Customized hierarchical classification for the mouse brain atlas
- `neuralib.atlas.brainrender`: cli-based wrapper for [brainrender](https://github.com/brainglobe/brainrender)
- `neuralib.atlas.cellatlas`: Volume and cell types counts for each brain region, refer
  to [Cell Atlas](https://portal.bluebrain.epfl.ch/resources/models/cell-atlas/)
- `neuralib.atlas.ibl`: Slice view plotting wrapper
  for [ibllib](https://github.com/int-brain-lab/ibllib?tab=readme-ov-file)
  and [iblatlas](https://int-brain-lab.github.io/iblenv/_autosummary/ibllib.atlas.html)

### bokeh_model

- `neuralib.bokeh_model`: Interactive dashboard visualization

### calimg

- Module for 2photon calcium imaging acquisition and result parsing
- `neuralib.calimg.scan_image`: Data acquired from [ScanImage](https://www.mbfbioscience.com/products/scanimage/) (under
  DEV)
- `neuralib.calimg.scanbox`: Data acquired from [Scanbox](https://scanbox.org/tag/two-photon/)
- `neuralib.calimg.suite2p`:  Result parser for [suite2p](https://github.com/MouseLand/suite2p)

### model

- under DEV

### persistence

- Module for caching the analyzed results (i.e., concatenation for statistic purpose)

### plot

- Module for general plotting purpose

### scanner

- Module for parsing Zeiss confocal scanning data
- `neuralib.scanner.czi`: .czi data format
- `neuralib.scanner.lsm`: .lsm data format

### segmentation

- Module for cellular segmentation
- `neuralib.segmentation.cellpose`: Result Parser and batch running
  for [cellpose](https://github.com/MouseLand/cellpose)
- `neuralib.segmentation.stardist`: Result Parser and batch running for [stardist](https://github.com/stardist/stardist)

### stimpy

- Tools and Result parser for visual-guided behavior dataset
- Acquisition system are currently only lab internal usage

### tools

- `neuralib.tools.imglib`: Image processing library (under DEV)
- `neuralib.tools.slack_bot`: Real-time slack notification bot for analysis pipeline

### wrapper

- Module for other open-source tools wrapper
- `neuralib.tools.deeplabcut`: Result parser for [DeepLabCut](https://github.com/DeepLabCut/DeepLabCut)
- `neuralib.tools.facemap`: Result parser for [facemap](https://github.com/MouseLand/facemap)
- `neuralib.tools.rastermap`: Run and result parser for [rastermap](https://github.com/MouseLand/rastermap)

### util

- `cli_args`: run script as subprocess
- `color_logging`: logging with color format
- `csv`: csv context manager
- `gpu`: OS-dependent gpu info
- `profile_test`: simple benchmark profile testing
- `table`: rich table visualization

## project.scripts using cli

### `brender`

- see examples in [api](https://neuralib.readthedocs.io/en/latest/api/neuralib.atlas.brainrender.html)

### `ppv`

- python pickle/parquet file viewer
  ~~~
  ppv <FILE>
  ~~~
- see `-h` for detail
