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

Clarification: inc_structure behaviour? #920

Closed
kavanase opened this issue Jul 6, 2024 · 1 comment
Closed

Clarification: inc_structure behaviour? #920

kavanase opened this issue Jul 6, 2024 · 1 comment

Comments

@kavanase
Copy link

kavanase commented Jul 6, 2024

Hi!
Thanks for your work developing this package and sorry to be bugging about this, but I was wondering if we could get clarification about the new default inc_structure behaviour with the new API methods. The previous inc_structure argument has now been deprecated:

inc_structure (str): *This is a deprecated argument*. Previously, if None, entries
                returned were ComputedEntries. If inc_structure="initial",
                ComputedStructureEntries with initial structures were returned.
                Otherwise, ComputedStructureEntries with final structures
                were returned. This is no longer needed as all entries will contain
                structure data by default.

As it says in the docstrings now, it's no longer needed as structure data is always returned, but it doesn't say which structure (i.e. initial or final) is returned. I've tried searching through the code but I can't really tell how this is now handled by default, though from some manual checks it seems like it's returning the final MP-relaxed structure. But it would be good to get confirmation of this if possible please?
We've found in a few cases that when relaxing with different functional setups (e.g. hybrid DFT, vdW corrections etc), sometimes starting from the MP-relaxed structure can result in a different structure than starting from the "initial'" (often ICSD) structure, due to being in a local minimum, so important to know. Is there any way to access the "initial" structures through the new MP API? (as was possible before with the legacy API)
Thanks!

@munrojm
Copy link
Member

munrojm commented Jul 11, 2024

Hi @kavanase, I can confirm it is the final relaxed MP structure that is included in the entry object. We should clarify that in the docs.

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

2 participants