Metadata-Version: 2.1
Name: nwbinspector
Version: 0.4.20
Summary: Tool to inspect NWB files for best practices compliance.
Home-page: https://nwbinspector.readthedocs.io/
Author: Ryan Ly, Ben Dichter, and Cody Baker.
Author-email: rly@lbl.gov, ben.dichter@gmail.com, cody.baker@catalystneuro.com
License: BSD-3-Clause
Description: <img src="docs/logo/logo.png" width="300">
        
        [![PyPI version](https://badge.fury.io/py/nwbinspector.svg)](https://badge.fury.io/py/nwbinspector)
        [![ReadTheDocs](https://readthedocs.org/projects/nwbinspector/badge/?version=dev)](https://nwbinspector.readthedocs.io/)
        ![Tests](https://github.com/NeurodataWithoutBorders/nwbinspector/actions/workflows/testing.yml/badge.svg)
        [![codecov](https://codecov.io/gh/NeurodataWithoutBorders/nwbinspector/branch/dev/graphs/badge.svg?branch=dev)](https://codecov.io/github/NeurodataWithoutBorders/nwbinspector?branch=dev)
        [![License](https://img.shields.io/pypi/l/pynwb.svg)](https://github.com/NeurodataWithoutBorders/nwbinspector/license.txt)
        
        Inspect NWB files for compliance with [NWB Best Practices](https://nwbinspector.readthedocs.io/en/dev/best_practices/best_practices_index.html). This inspector is meant as a companion to the PyNWB validator, which checks for strict schema compliance. In contrast, this tool attempts to apply some common sense to find components of the file that are technically compliant, but possibly incorrect, suboptimal in their representation, or deviate from best practices. This tool is meant simply as a data review aid. It does not catch all best practice violations, and any warnings it does produce should be checked by a knowledgeable reviewer.
        
        ## Installation
        ```bash
        pip install nwbinspector
        ```
        
        ## Usage
        
        ```bash
        # supply a path to an NWB file
        nwbinspector path/to/my/data.nwb
        
        # supply a path to a directory containing NWB files
        nwbinspector path/to/my/data/dir/
        ```
        
Keywords: nwb
Platform: UNKNOWN
Description-Content-Type: text/markdown
Provides-Extra: dandi
