search

pr-omethe-us / pyked-papers

Various papers published about PyKED
Creative Commons Attribution 4.0 International
0 stars 0 forks source link

IJCK R2C16 #33

Closed bryanwweber closed 6 years ago

bryanwweber commented 6 years ago

The Python package Cerberus is used to validate the format and content of the given ChemKED file. How does this package handles/reports the inconsistencies with the schemas? As far as my local test went with giving a corrupted YAML file to the ChemKED initiator, the package just spits out a Python error, which might be not the most user-friendly solution.

bryanwweber commented 6 years ago

Ref: https://github.com/pr-omethe-us/pyked-papers/issues/3#issuecomment-332316621

From Kyle:

We've already talked about the less-than-useful error messages that Cerberus gives; I'm not sure if there's anything we can do here other than address the issue and say we plan to improve these in the future.

bryanwweber commented 6 years ago

Indeed, this is going to require some work on Cerberus itself, as well as work in PyKED.

kyleniemeyer commented 6 years ago

Perhaps that's what we can say, but also add something to the paper & PyKED docs that says something like "currently errors in ChemKED files may lead to complicated error messages; here are some common issues & fixes"

bryanwweber commented 6 years ago

The issue that was holding this up was fixed by someone else! https://github.com/pyeve/cerberus/issues/278#event-1272668611 Wahoo! Now we just need him to make a new release :smile:

bryanwweber commented 6 years ago

Whoops, put the wrong issue in the commit to address this: https://github.com/pr-omethe-us/pyked-papers/commit/0471f9664c6ba96fe0b052b5071d272a161801f9

kyleniemeyer commented 6 years ago

Response seems fine; this is a PyKED issue and not ChemKED itself, so I think we're fine to leave as open issue to be resolved.