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

Add ability to request additional OPTIMADE fields #2315

Merged

Conversation

ml-evs
Copy link
Contributor

@ml-evs ml-evs commented Nov 29, 2021

Summary

Closes #2314 by adding the additional_response_fields argument when generating SNLs from OPTIMADE requests.

Checklist

Work-in-progress pull requests are encouraged, but please put [WIP]
in the pull request title.

Before a pull request can be merged, the following items must be checked:

  • Code is in the standard Python style. The easiest way to handle this
    is to run the following in the correct sequence on your local machine. Start with running
    black on your new code. This will automatically reformat
    your code to PEP8 conventions and removes most issues. Then run
    pycodestyle, followed by
    flake8.
  • Docstrings have been added in the Google docstring format.
    Run pydocstyle on your code.
  • Type annotations are highly encouraged. Run mypy to type check your code.
  • Tests have been added for any new functionality or bug fixes.
  • All linting and tests pass.

Note that the CI system will run all the above checks. But it will be much more efficient if you already fix most
errors prior to submitting the PR. It is highly recommended that you use the pre-commit hook provided in the pymatgen
repository. Simply cp pre-commit .git/hooks and a check will be run prior to allowing commits.

- This allows users to request additional fields when
generating SNLs from OPTIMADE data. The keys are stored
in the _optimade namespace.
@ml-evs ml-evs force-pushed the ml-evs/optimade_response_fields branch from 90a03e7 to 642431e Compare November 29, 2021 15:59
@ml-evs ml-evs marked this pull request as ready for review November 29, 2021 16:00
@coveralls
Copy link

coveralls commented Nov 29, 2021

Coverage Status

Coverage decreased (-0.6%) to 83.127% when pulling 642431e on ml-evs:ml-evs/optimade_response_fields into dd37370 on materialsproject:master.

@mkhorton
Copy link
Member

Thanks @ml-evs, this is useful, I appreciate you have this working with the SNL objects too.

@mkhorton mkhorton merged commit e6c3366 into materialsproject:master Nov 29, 2021
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

Successfully merging this pull request may close these issues.

OptimadeRester: Add ability to request additional response fields
3 participants