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

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.6.0.tar.gz (593.2 kB view details)

Uploaded Source

Built Distribution

nwbinspector-0.6.0-py3-none-any.whl (63.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nwbinspector-0.6.0.tar.gz
  • Upload date:
  • Size: 593.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for nwbinspector-0.6.0.tar.gz
Algorithm Hash digest
SHA256 b8162704dbd828588422930f0c8ac2a225e3a040e1f726df9878c3e14e15ee04
MD5 b13b2f6b07e68a885f059a4a82937472
BLAKE2b-256 5c6e892a2660bd995c385e47393e99146390cff9da99d457580f1a0628b0f2a9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nwbinspector-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 63.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for nwbinspector-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 39730229e34c4fc5a903a5f9cb9e5ce81eb080486d9e71dac5a03d68383986a9
MD5 9e344f1a5a0ebe9becaf706c62dbd82c
BLAKE2b-256 1e9c629ebd846659c57bb1b4754d2606a21b283712814a43f4b05ea1e3f34582

See more details on using hashes here.

Supported by

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