dbbs-lab / bsb-core

The Brain Scaffold Builder
https://bsb.readthedocs.io
GNU General Public License v3.0
22 stars 16 forks source link

`bsb audit` command #124

Open Helveg opened 4 years ago

Helveg commented 4 years ago

I've often encountered situations where I wasn't sure to throw an error, warn or do nothing because the warning would spam too much.

I introducing: audits. You can run the pluggable bsb audit command or bsb audit --fix command to check your entire project (#123 ) for mistakes or suboptimal practices.

AliceGem commented 4 years ago

Is it like a test?

Helveg commented 4 years ago

Not like the "testing" we do to validate the function of our code no. It's something that a modeller can run to make sure they aren't doing strange things. Like for example they could run an audit that warns you when there's an empty morphology in your repository:

So they are basically "overly sensitive" warnings that you can run on-demand so that we don't have to worry too much about the insensitivity of our regular warnings.

Helveg commented 4 years ago

Audit ideas

Helveg commented 3 years ago

Simone Torsello inspired me for a bsb audit hdf5 command that could check the integrity of HDF5 files!