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

Equation of State workflow for FHI-aims #889

Merged
merged 10 commits into from
Jul 16, 2024

Conversation

ansobolev
Copy link
Contributor

Summary

  • This PR adapts the common Equation of State workflow to FHI-aims.

Additional dependencies introduced (if any)

None

TODO (if any)

None

Checklist

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 ruff and ruff format on your new code. This will
    automatically reformat your code to PEP8 conventions and fix many linting issues.
  • Doc strings have been added in the Numpy docstring format.
    Run ruff 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 repository. Simply run
pre-commit install and a check will be run prior to allowing commits.

Copy link
Member

@janosh janosh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice work, esp. on the tests! 👍 lgtm

)

@classmethod
def from_parameters(cls, parameters: dict[str, Any], **kwargs) -> AimsEosMaker:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor nitpick but i would prob call this from_params for brevity.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This method is usually called from_parameters in aims workflows, I'd leave it as it is for compatibility

@janosh janosh added enhancement Improvements to existing features eos Equation of state labels Jun 22, 2024
@ansobolev
Copy link
Contributor Author

Hi, is there anything else we can do with the pull request?

@janosh
Copy link
Member

janosh commented Jul 16, 2024

thanks again @ansobolev, i'll go ahead and merge this! 👍

@janosh janosh merged commit 0817ede into materialsproject:main Jul 16, 2024
6 checks passed
BryantLi-BLI pushed a commit to BryantLi-BLI/atomate2 that referenced this pull request Jul 29, 2024
* Added EOS FHI-aims workflow

* Added tmp_path to phonon tests

* Added test data for EOS workflow

* Tests changed for older Pymatgen version

* simplify from_parameters

* Change the test reference value

---------

Co-authored-by: Janosh Riebesell <[email protected]>
hrushikesh-s pushed a commit to hrushikesh-s/atomate2 that referenced this pull request Nov 16, 2024
* Added EOS FHI-aims workflow

* Added tmp_path to phonon tests

* Added test data for EOS workflow

* Tests changed for older Pymatgen version

* simplify from_parameters

* Change the test reference value

---------

Co-authored-by: Janosh Riebesell <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvements to existing features eos Equation of state
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants