BUNPC / pysnirf2

Python package for reading, writing and validating Shared Near Infrared Spectroscopy Format (SNIRF) files
GNU General Public License v3.0
15 stars 11 forks source link

v0.3 #11

Closed sstucker closed 2 years ago

sstucker commented 2 years ago
rob-luke commented 2 years ago

Ready for me to take a shot using the validator @sstucker ?

sstucker commented 2 years ago

Sure!

I expect a few many bugs.

The end of the README has a quick guide to using it.

the gist is that you get a (bool, ValidationResult) from validateSnirf()

the ValidationResult is a structure containing a list of .issues which have the following attributes:

name  # The name of the issue
location # A location in the Snirf file matching an HDF5 name
id   # The ID of the issue
severity  # The severity level of the issue
message  # A string describing the issue

you can print them all out using its display() method

rob-luke commented 2 years ago

Too cool, I'll probably get to it tomorrow and will report back on my experience :+1: