Skip to content

Suggestions for improvements #2

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

Open
tovrstra opened this issue Jul 7, 2017 · 1 comment
Open

Suggestions for improvements #2

tovrstra opened this issue Jul 7, 2017 · 1 comment

Comments

@tovrstra
Copy link

tovrstra commented Jul 7, 2017

@dgasmith
I'm not making separate issues for every point below because these are just a bunch of small suggestions that occurred to me when going through the spec.

  • Could we just mention on top that atomic units are used throughout? That clarifies some points, e.g. Hartree cannot be the right unit for a frequency.
  • results would be a clearer name than variables.
  • It is good to have some room for non-standardized results and options. However, just to make this json schema more useful, we'd rather standardize as much as possible, e.g. as follows:
    • Only allow standard keys in the results/variables dictionary. Anything non-standard would better go to a other_results dictionary, such that there are no name collisions later on.
    • Similarly for options used to specify the input: standardize anything that sits in options, while non-standard keys could be put in other_options.
  • There seems to be little reason for a separate return_value. It could be included in results/variables.
@tovrstra
Copy link
Author

tovrstra commented Jul 7, 2017

P.S. One more suggestion came to mind: it would be nice to discourage overuse of upper case.

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