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

Version2 #15

Merged
merged 37 commits into from
Jul 10, 2024
Merged

Version2 #15

merged 37 commits into from
Jul 10, 2024

Conversation

kvhuguenin
Copy link
Contributor

@kvhuguenin kvhuguenin commented Jun 11, 2024

Update adding many of the desired features to MeshLODE. In particular, this adds:

  1. new calculators implementing a full Ewald sum also including the short-range part (with and without mesh)
  2. Real and reciprocal space versions of the implementation to also enable testing on aperiodic systems
  3. A separate potentials class that can handle arbitrary potential exponents with arbitrary splits into SR and LR parts
  4. Option in the Ewald calculators to subtract the interior contribution to obtain a purely long-range descriptor
  5. Significant changes to code structure relying more on class inheritance, not to duplicate code among the many calculators

Checklist until the PR can be merged:

  • Add tests for potentials class
  • Add test structures with anion-cation ratios other than 1:1 to catch potential edge cases
  • Add simple examples showcasing full differentiability and use with pytorch on simple toy models
  • Test that the code can be integrated into more complex torch models without issues
  • Benchmark accuracy and convergence of the PME calculator that now also includes the SR part, in normal mode
  • Benchmark accuracy and convergence of the PME calculator that now also includes the SR part, in"subtract interior" mode
  • Add metatensor as an output format for the new calculators
  • Documentation: all user-facing functions need to be properly documented

📚 Documentation preview 📚: https://meshlode--15.org.readthedocs.build/en/15/

@kvhuguenin kvhuguenin self-assigned this Jun 11, 2024
@PicoCentauri PicoCentauri merged commit fc385d1 into main Jul 10, 2024
4 of 5 checks passed
@PicoCentauri PicoCentauri deleted the version2 branch July 10, 2024 12:43
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.

2 participants