Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions deepmd/pt/nvalchemi/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# SPDX-License-Identifier: LGPL-3.0-or-later
"""Optional bridge between DeePMD-kit SeZM / DPA-4 models and NVIDIA's
``nvalchemi-toolkit`` molecular-dynamics framework.

``nvalchemi-toolkit`` is an optional dependency. Importing this subpackage
without it installed raises a clear, actionable error instead of an opaque
``ModuleNotFoundError`` deep in the import chain.

Example
-------
::

from deepmd.pt.nvalchemi import DPA4Wrapper
from nvalchemi.data import AtomicData, Batch
from nvalchemi.neighbors import compute_neighbors

model = DPA4Wrapper.from_checkpoint("model.pt", device="cuda")
batch = Batch.from_data_list([data], device="cuda")
compute_neighbors(batch, config=model.model_config.neighbor_config)
out = model(batch) # {"energy": (B, 1), "forces": (N, 3), ...}
"""

from __future__ import (
annotations,
)

try:
import nvalchemi # noqa: F401
except ImportError as e: # pragma: no cover - exercised only without the dep
raise ImportError(
"deepmd.pt.nvalchemi requires the optional `nvalchemi-toolkit` package. "
"Install it with `pip install deepmd-kit[nvalchemi]` "
"(or `pip install nvalchemi-toolkit`)."
) from e

from .dpa4wrapper import (
DPA4Wrapper,
SeZMWrapper,
)

__all__ = ["DPA4Wrapper", "SeZMWrapper"]
Loading
Loading