search

FaradayInstitution / BPX

BPX schema in pydantic and JSON schema format, and parsers
MIT License
25 stars 12 forks source link

Validation based on models #29

Closed rtimms closed 11 months ago

rtimms commented 1 year ago

Checking for required parameters should be done by model (e.g. SPM needs fewer parameters than DFN). Allows users to share "partial" BPX that is sufficient for reduced models.

rtimms commented 1 year ago

Have a warn or error on validation against a model. This would support sharing "partial" BPX files where all the fields are valid and consistent but not all the required parameters are there for any given model. Useful for e.g. sharing parameters fro a single electrode. SEe #40

ejfdickinson commented 1 year ago

Do we have a standard specification document that says which parameters need to be defined for which models?

This is implied by Ferran's paper on which the original BPX (DFN) is based, but I think we need to express it formally before we can define the correctness or otherwise of the implementation in #34 .

@ikorotkin Did you make such a specification document? Otherwise I can put one together.

rtimms commented 11 months ago

done in #34