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

[WIP] Add I/O interface with Metalwalls #3193

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

chiang-yuan
Copy link
Contributor

@chiang-yuan chiang-yuan commented Jul 29, 2023

MetalWalls (MW) is a molecular dynamics code dedicated to the modelling of electrochemical systems. Its main originality is the inclusion of a series of methods allowing to apply a constant potential within the electrode materials.

This is the same PR but without dirty commit from other branch. The input classes are mostly finished.

  • Need to add string representation for classes and file export method to print out runtime.inpt file
  • Data input class. Should be convenient to convert Structure to metalwalls data.inpt format
  • Output classes for post-processing
  • Add tests

Detailed implementation

Input

Top level parameter keywords

Top level block keywords

Data

Output

None

Checklist

  • Google format doc strings added. Check with ruff.
  • Type annotations included. Check with mypy.
  • Tests added for new features/fixes.
  • If applicable, new classes/functions/modules have duecredit @due.dcite decorators to reference relevant papers by DOI (example)

@janosh janosh added needs testing PRs that are not ready to merge due to lacking tests io Input/output functionality feature PRs with new features, not enhancements to existing features labels Sep 12, 2023
Copy link
Member

Choose a reason for hiding this comment

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

I think better to be explicit here and write out the name: pymatgen/io/metalwalls/__init__.py

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @janosh! Will change that when I get back to this. It has been put off in my TODOs and is going to stale for a while.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature PRs with new features, not enhancements to existing features io Input/output functionality needs testing PRs that are not ready to merge due to lacking tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants