Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Validation tool #10

Open
JackKelly opened this issue Jul 23, 2014 · 1 comment
Open

Validation tool #10

JackKelly opened this issue Jul 23, 2014 · 1 comment

Comments

@JackKelly
Copy link
Contributor

No description provided.

@JackKelly
Copy link
Contributor Author

Some quick thoughts: could have a single, machine-readable schema which we then use to generate docs, validator and wizard. Probably easiest to create the machine-readable schema in Python. e.g. we'd have a dataset_schema.py file containing an OrderedDict where keys are the key name in the metadata instant (e.g. 'instant') and values would be a dict with keys like 'type' (a list of classes e.g. 'int' or 'float' or 'TimeFrame'), and a 'description' (for the docs), 'required'. Based on JSONSchema. Because it's an OrderedDict that's the order we use for the docs and the wizard. Nested dicts should be allowed. lists should be allowed (use similar language to JSONSchema... e.g. 'type' = 'array', 'items' = 'TimeFrame', etc). Import list of AC_TYPES etc from NILMTK.

Not planning to do this any time soon. Just making a note here for future reference. If anyone else fancies doing this then go for it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant