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.1.tar.gz (629.8 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.1-py3-none-any.whl (85.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nwbinspector-0.7.1.tar.gz
  • Upload date:
  • Size: 629.8 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.1.tar.gz
Algorithm Hash digest
SHA256 a2f3650d6c8440109900400e125424b99c4fb17110e0398f7474820febb98e9b
MD5 cd3f4ed7629a4dac87d3299daf29d151
BLAKE2b-256 acfce9250afdcfd1d9299265a19f32122e3dbf766c2f92ff99aafd0a1cc627b8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nwbinspector-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 85.5 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 10d0392d4eb8d6e64c08439ebd93a88890114ca08a51d1e6af33b31353193bf2
MD5 d0b9fa0c75fda3e1403beebe13c59588
BLAKE2b-256 6e78aa62c1cec806773203fb99dbb2d5ec0c9516bc749101deec23e8c96307f5

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