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 solvent interface placement code #765

Merged
merged 18 commits into from
Aug 9, 2024
Merged

Add solvent interface placement code #765

merged 18 commits into from
Aug 9, 2024

Conversation

mshuaibii
Copy link
Collaborator

@mshuaibii mshuaibii commented Jul 16, 2024

OC code is currently limited to adding single/multi adsorbates on clean surfaces. This PR extends this functionality to more complicated interfaces. Specifically - the inclusion of solvents and ions.

Solvent placement utilizes packmol and components from https://github.com/henriasv/molecular-builder/tree/master.

Also squeezed in a change to Slab.from_bulk_get_random_slab to speed up that generation by ~2x. Rather than enumerating all slabs then sampling randomly, enumerate just the miller indices then construct a slab from that instead.

mshuaibii and others added 4 commits July 16, 2024 16:49
…unami enumeration (#764)

* adding new notebook for using fairchem models with NEBs

* adding md tutorials

* blocking code cells that arent needed or take too long
Copy link

codecov bot commented Jul 17, 2024

Codecov Report

Attention: Patch coverage is 80.07663% with 52 lines in your changes missing coverage. Please review.

Files Patch % Lines
src/fairchem/data/oc/utils/geometry.py 63.04% 34 Missing ⚠️
src/fairchem/data/oc/core/interface_config.py 91.30% 8 Missing ⚠️
src/fairchem/data/oc/core/ion.py 79.31% 6 Missing ⚠️
src/fairchem/data/oc/core/solvent.py 86.20% 4 Missing ⚠️
Files Coverage Δ
src/fairchem/data/oc/core/__init__.py 100.00% <100.00%> (ø)
src/fairchem/data/oc/core/slab.py 80.10% <100.00%> (ø)
src/fairchem/data/oc/databases/pkls/__init__.py 100.00% <100.00%> (ø)
src/fairchem/data/oc/utils/vasp.py 77.77% <100.00%> (-0.80%) ⬇️
src/fairchem/data/oc/utils/vasp_flags.py 100.00% <100.00%> (ø)
src/fairchem/data/oc/core/solvent.py 86.20% <86.20%> (ø)
src/fairchem/data/oc/core/ion.py 79.31% <79.31%> (ø)
src/fairchem/data/oc/core/interface_config.py 91.30% <91.30%> (ø)
src/fairchem/data/oc/utils/geometry.py 63.04% <63.04%> (ø)

@mshuaibii mshuaibii changed the base branch from main to new-cattsunami-nb July 19, 2024 01:01
@mshuaibii mshuaibii changed the base branch from new-cattsunami-nb to main July 19, 2024 01:12
Copy link
Collaborator

@lbluque lbluque left a comment

Choose a reason for hiding this comment

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

I left some comments on the design of Geometry classes, and a few minor comments.

.github/workflows/test.yml Show resolved Hide resolved
src/fairchem/data/oc/core/interface_config.py Show resolved Hide resolved
src/fairchem/data/oc/core/interface_config.py Show resolved Hide resolved
src/fairchem/data/oc/core/slab.py Show resolved Hide resolved
src/fairchem/data/oc/core/solvent.py Outdated Show resolved Hide resolved
src/fairchem/data/oc/utils/geometry.py Outdated Show resolved Hide resolved
src/fairchem/data/oc/utils/geometry.py Outdated Show resolved Hide resolved
src/fairchem/data/oc/utils/geometry.py Show resolved Hide resolved
@mshuaibii mshuaibii requested a review from lbluque July 26, 2024 00:33
lbluque
lbluque previously approved these changes Jul 30, 2024
Copy link
Collaborator

@lbluque lbluque left a comment

Choose a reason for hiding this comment

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

lgtm! just minor comments

src/fairchem/data/oc/utils/geometry.py Outdated Show resolved Hide resolved
src/fairchem/data/oc/utils/geometry.py Outdated Show resolved Hide resolved
src/fairchem/data/oc/utils/geometry.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@lbluque lbluque left a comment

Choose a reason for hiding this comment

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

lgtm

@lbluque lbluque added this pull request to the merge queue Aug 9, 2024
Merged via the queue into main with commit 917056a Aug 9, 2024
7 checks passed
@lbluque lbluque deleted the oc_solvents branch August 9, 2024 01:58
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.

3 participants