deepmodeling / deepmodeling/tbplas

[Code scan] Add the missing h5py dependency for the DeepH example

Open
#25 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
19
Forks
6
PR merge metrics
No merged PRs in 30d

Description

This issue comes from a Codex global scan of deepmodeling/tbplas at commit 4d3652b3dba8eb930e4869a6d41074f62d703692.

Severity: Low

The DeepH interface example imports `h5py`, but the install documentation lists only `ase` and `mpi4py` as optional packages. Users following the docs can hit `ModuleNotFoundError` when running the example.

Code references:
https://github.com/deepmodeling/tbplas/blob/4d3652b3dba8eb930e4869a6d41074f62d703692/examples/interface/deeph/read_deeph.py#L19
https://github.com/deepmodeling/tbplas/blob/4d3652b3dba8eb930e4869a6d41074f62d703692/doc/source/install.rst#L53-L56
https://github.com/deepmodeling/tbplas/blob/4d3652b3dba8eb930e4869a6d41074f62d703692/INSTALL.rst#L53-L56

Suggested fix: add an optional dependency group for the DeepH interface or document `h5py` alongside the other optional packages.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.