Skip to main content

Tool to inspect NWB files for best practices compliance.

Project description

NWB Inspector logo

Supported Python versions codecov

PyPI latest release version License: BSD-3 DOI

Python code style: Black Python code style: Ruff

Documentation build status Daily tests

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. 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

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

Read about more detailed usage in the main documentation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nwbinspector-0.7.2.tar.gz (634.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nwbinspector-0.7.2-py3-none-any.whl (86.9 kB view details)

Uploaded Python 3

File details

Details for the file nwbinspector-0.7.2.tar.gz.

File metadata

  • Download URL: nwbinspector-0.7.2.tar.gz
  • Upload date:
  • Size: 634.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for nwbinspector-0.7.2.tar.gz
Algorithm Hash digest
SHA256 2e49bee5e5de9bcf2cd8e293aa88d8cf845a4a2a16387052aebd7faef8230ab4
MD5 777224f953553307b759cda9e4cbec35
BLAKE2b-256 2e7dfcb4b0002445cc940dad1277e88dc840ee229cd628d404b693cf05bbafe8

See more details on using hashes here.

File details

Details for the file nwbinspector-0.7.2-py3-none-any.whl.

File metadata

  • Download URL: nwbinspector-0.7.2-py3-none-any.whl
  • Upload date:
  • Size: 86.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for nwbinspector-0.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 40d008eedd8afdc5d6841825d6efb6891933c1fd3b8c5b599ab2db14f62db8e8
MD5 ab49591c7bd23788722b4fcf94092639
BLAKE2b-256 3f0b9ed001e9d16a94ea5bd74dee2462786fcc869c4bcb3dd568c2373ac9d260

See more details on using hashes here.

Supported by

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