Example: a clay mineral with MINFF built with the Layer Builder (layers, interlayer ions and water, GROMACS)
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 20/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Domain
- documentation
Research direction
Start with the existing Materials Chemistry examples and the Tools > Layer Builder entry in ECCE, then check how GROMACS Prepare handles MINFF typing through atomipy. The work is a worked example: build a clay layer with a substitution, stack it with interlayer ions and water, run Optimize, Equilibrate (NPT) and Dynamics, then analyse d(001), density profiles and the powder 001 reflection. It is done when the topology charges match the intended layer charge and d(001) is compared with a named published value.
Written by the indexing model from the issue text.
Description
There is no example of MINFF (the min.ff mineral force field ECCE bundles with atomipy) or of building a layered material with the Layer Builder. Wanted, in the Materials Chemistry examples (and as a worked chapter of the manual):
- The layer: a clay layer from a published crystal structure (e.g. pyrophyllite or a montmorillonite model, from COD/AMCSD, source named), with its cell, in the Builder; isomorphic substitution (Al→Mg in the octahedral sheet, or Si→Al in the tetrahedral sheet) to give the layer charge, done in ECCE.
- The stack: Tools > Layer Builder: number of layers, interlayer spacing, shift; interlayer counter-ions (Na⁺) and water filled into the gaps.
- MINFF in GROMACS: GROMACS Prepare with MINFF (atomipy typing, ion parameter set HFE or IOD, minimum ion distance for a thin interlayer, #363), then Optimize, Equilibrate (NPT, so the interlayer spacing relaxes) and Dynamics.
- What it shows: the basal spacing d(001) against water content (one-layer and two-layer hydrates), the ion and water density profiles across the interlayer (MD Analysis > Density profile along c), and the powder pattern's 001 reflection from the equilibrated cell (Diffraction), which is what an XRD measurement of a clay reports.
Checks: the topology charges sum to the intended layer charge; the equilibrated d(001) compared with a published value for the same hydration state (source named). Force-field choices (MINFF version, ion set, water model) stated in the annotation; anything not checked against a published MINFF study is labelled as such. Notes in the short example style.
- Dominant language
- C
- Stars
- 10
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from FriendsofECCE/ECCE
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
FriendsofECCE/ECCE#1018 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
FriendsofECCE/ECCE#336 · 1 comment ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 20/100
FriendsofECCE/ECCE#1021 ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 15/100
FriendsofECCE/ECCE#1019 ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 15/100
FriendsofECCE/ECCE#1016 · 1 comment ·
All issues in FriendsofECCE/ECCE
Similar issues
-
Status: Opened
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
immortalwrt/immortalwrt#2522 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
severity: low
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
luainkernel/lunatik#2530 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
conan-io/conan#20500 · 1 comment ·
Maintainers usually reply within 1 day