Tool to inspect NWB files for best practices compliance.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for bendichter from gravatar.com bendichter Avatar for cbaker9 from gravatar.com cbaker9 Avatar for rly from gravatar.com rly Avatar for stephprince from gravatar.com stephprince

Unverified details

These details have not been verified by PyPI
Project links
Meta
Report project as malware

Project description

PyPI version ReadTheDocs Tests codecov License

Inspect NWB files for compliance with NWB Best Practices. 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 probably incorrect, or suboptimal, 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.

This project is under active development. You may use this as a stand-alone tool, but we do not advise you to code against this project at this time as we do expect the warnings to change as the project develops.

Installation

pip install nwbinspector

Usage

# 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/

# optional: supply modules to import before reading the file, e.g., for NWB extensions
nwbinspector path/to/my/data.nwb -m my_extension_module1 my_extension_module2

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page