https://github.com/neurodatawithoutborders/nwbinspector

Tool to help inspect NWB files for compliance with NWB Best Practices
https://github.com/neurodatawithoutborders/nwbinspector

nwb

Last synced: 6 days ago
JSON representation

Tool to help inspect NWB files for compliance with NWB Best Practices

• Host: GitHub
• URL: https://github.com/neurodatawithoutborders/nwbinspector
• Owner: NeurodataWithoutBorders
• License: other
• Created: 2019-11-15T19:24:02.000Z (about 5 years ago)
• Default Branch: dev
• Last Pushed: 2024-12-03T18:37:51.000Z (19 days ago)
• Last Synced: 2024-12-03T19:33:42.627Z (19 days ago)
• Topics: nwb
• Language: Python
• Homepage: https://nwbinspector.readthedocs.io/
• Size: 3 MB
• Stars: 17
• Watchers: 10
• Forks: 10
• Open Issues: 62
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: license.txt
  • Code of conduct: .github/CODE_OF_CONDUCT.rst

Awesome Lists containing this project

README

        


  

  


    

    

  

  


    

    

  

  


    

    

  

  


    

    

  


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. 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 possible violations of best practices 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/folder/

```

Read about more detailed usage in the main [documentation](https://nwbinspector.readthedocs.io/en/dev/user_guide/user_guide_index.html).