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.0.tar.gz (609.6 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.0-py3-none-any.whl (70.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nwbinspector-0.7.0.tar.gz
  • Upload date:
  • Size: 609.6 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.0.tar.gz
Algorithm Hash digest
SHA256 ba176b0d93ac3300990b1009b4383d9e06cd8e156336020effc958dc14f54868
MD5 66cf2829b6a4aefeeb6f437239d71dd5
BLAKE2b-256 1361217d0cf592cf1335699dcbf31831c970a54924d9e78b5ba569378c369984

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nwbinspector-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 70.0 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b0084f545148ee737bd6477b3221d50418769c20570d179c93381d86dae271b8
MD5 070ea41c35bf1e9d7198de9c0c31beff
BLAKE2b-256 ae1d7cf2fad802ff7820fc68178de5692adf9847d91781641bea2d0dae348075

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