Skip to content

Add a warning if using NPT - #90

Merged
shyuep merged 2 commits into
materialyzeai:mainfrom
Andrew-S-Rosen:patch-2
Aug 6, 2025
Merged

Add a warning if using NPT#90
shyuep merged 2 commits into
materialyzeai:mainfrom
Andrew-S-Rosen:patch-2

Conversation

@Andrew-S-Rosen

Copy link
Copy Markdown
Contributor

Since ASE strongly recommends against using the NPT class, this PR raises a UserWarning if it is called. The hope is that this will inform the user to instead consider one of the other ASE-recommended NPT dynamics classes.

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)

Tip: Install pre-commit hooks to auto-check types and linting before every commit:

pip install -U pre-commit
pre-commit install

Andrew-S-Rosen and others added 2 commits August 6, 2025 18:09
Since ASE strongly recommends against using the `NPT` class, this PR raises a `UserWarning` if it is called. The hope is that this will inform the user to instead consider one of the other ASE-recommended NPT dynamics classes.

Signed-off-by: Andrew S. Rosen <asrosen93@gmail.com>
@shyuep
shyuep merged commit 452abf1 into materialyzeai:main Aug 6, 2025
0 of 3 checks passed
@shyuep

shyuep commented Aug 6, 2025

Copy link
Copy Markdown
Contributor

Thanks.

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