kYangLi/DeepH-dock
kYangLi/DeepH-dock has 43 GitHub stars and 6 forks. GitHot measured 0 stars in 24 hours, 0 in 7 days, and +1 in 15 days. Last checked 2026-11-18 14:40 UTC. Last push 2026-11-02.
What you can do
- Multi-Software Compatibility: Seamlessly bridges major DFT packages (e.g., SIESTA, QE, OpenMX, FHI-aims, ABACUS) with the DeepH deep learning family and downstream tight-binding toolchains.
- High-Performance Computational Core: Implements high-performance algorithms for automated structure generation, overlap matrix calculation, Hamiltonian symmetrization, and fast diagonalization via KPM/Lanczos.
- Standardized Workflows: Streamlines the full research lifecycle with automated pipelines for DFT data generation, preprocessing, post-analysis, and custom composite workflows.
- Utility Toolkit: Empowers developers with a robust set of tools for multi-level parallel computing (MPI/threads), versatile format conversion, and rigorous data integrity validation.
Progression mesurée des étoiles
- in 24h
- 0
- in 7 days
- 0
- in 15 days
- +1
- in 1 month
- Historique en cours
Variations nettes sur des périodes qui se chevauchent, pas des totaux quotidiens. Les mesures absentes restent vides. Les étoiles indiquent l’intérêt, pas la qualité.
À propos
DeepH-dock seamlessly integrates deep learning with first-principles calculations. It serves as a modular and extensible bridge, functioning both as the dedicated interface for the DeepH-pack suite and as a standalone tool for coupling deep learning models with computational materials science workflows.
Apprentissage automatiqueREADME.md
Original
Integrating deep learning into first-principles calculations
Modular, extensible bridge between first-principles calculations and the DeepH method
DeepH-dock is a modular, extensible interface platform for quantum materials calculations, dedicated to building efficient and reliable bridges between first-principles calculations and the DeepH (deep learning Hamiltonian) method. This platform integrates multiple density functional theory (DFT) software interfaces, supports DeepH predictions, and provides standardized data processing. It also functions independently as a post-processing tool for DFT calculations.
At the core of DeepH-dock is a unified and flexible interface layer that seamlessly connects mainstream DFT packages with the DeepH workflow, enabling users to generate and utilize deep learning-based Hamiltonians with minimal effort. DeepH-dock offers first-class support for heterogeneous computational environments, allowing researchers to orchestrate complex multi-software workflows through a consistent Python API.
DeepH-dock also establishes a unified data format tailored for machine learning in materials science, facilitating efficient implementations of both force fields and electronic structure methods.
For the most comprehensive usage documentation, please visit https://docs.deeph-pack.com/deeph-dock.
For the latest version-specific documentation of DeepH-pack, please refer to the corresponding repository.
Core Features
Multi-Software Compatibility: Seamlessly bridges major DFT packages (e.g., SIESTA, QE, OpenMX, FHI-aims, ABACUS) with the DeepH deep learning family and downstream tight-binding toolchains.
High-Performance Computational Core: Implements high-performance algorithms for automated structure generation, overlap matrix calculation, Hamiltonian symmetrization, and fast diagonalization via KPM/Lanczos.
Standardized Workflows: Streamlines the full research lifecycle with automated pipelines for DFT data generation, preprocessing, post-analysis, and custom composite workflows.
Utility Toolkit: Empowers developers with a robust set of tools for multi-level parallel computing (MPI/threads), versatile format conversion, and rigorous data integrity validation.
Quick Start
Installation
Publish version:
pip install deepx-dock
Development version:
pip install git+https://github.com/kYangLi/DeepH-dock
Basic Usage
run dock -h,
Usage: dock [OPTIONS] COMMAND [ARGS]...
DeepH-dock: Materials computation and data analysis toolkit.
Options:
-v, --version Show the version and exit.
-h, --help Show this message and exit.
Commands:
analyze
compute
convert
design
ls List all available commands.
completion Shell completion management commands.
Shell Auto-Completion
DeepH-dock provides intelligent tab completion for dock commands. Enable it for your shell:
# Bash
dock completion init bash
# Zsh
dock completion init zsh
# Fish
dock completion init fish
After setup, reload your shell or run source ~/.bashrc (or ~/.zshrc for Zsh). Press Tab to auto-complete commands and options.
For detailed setup instructions, see Installation & Setup.
Citation
Any and all use of this software, in whole or in part, should clearly acknowledge and link to this repository.
If you use this code in your academic work, please cite the complete package featuring the latest implementation, methodology, and workflow of DeepH:
@article{li2026deeph,
title={DeepH-pack: a general-purpose neural network package for deep-learning electronic structure calculations},
author={Li, Yang and Wang, Yanzhen and Zhao, Boheng and Gong, Xiaoxun and Wang, Yuxiang and Tang, Zechen and Wang, Zixu and Yuan, Zilong and Li, Jialin and Sun, Minghui and Chen, Zezhou and Tao, Honggeng and Wu, Baochun and Yu, Yuhang and Li, He and da Jornada, Felipe H. and Duan, Wenhui and Xu, Yong},
journal={npj Comput. Mater.},
volume={12},
pages={361},
year={2026},
doi={10.1038/s41524-026-02219-2}
}
Application Scenarios
- High-Throughput Materials Calculations: Automated generation and processing of electronic structure data for large material sets
- Deep Learning Training Data Preparation: Preparing standardized training datasets for neural network models
- Tight-Binding Parameter Fitting: Connecting DFT calculations with tight-binding model parameterization
- Method Development and Validation: Rapid implementation and testing of new computational algorithms
Contributing
We welcome contributions from the community! To ensure a consistent and maintainable codebase, please follow the structured workflow below when adding new functionality.
Development Workflow for Contributors
A brief summary is provided below. Complete documentation can be found in the Development Guide.
Identify the Target Module
First, determine which major module your contribution belongs to, based on the project architecture (e.g.,
analyze,compute,convert,design).Create Your Submodule
Create a new folder for your submodule within the corresponding parent module. For example, if you are implementing an interface between FHI-aims and DeepH, create it under
deepx_dock/convert/fhi_aims/.Implement Your Functionality
Package the core logic you wish to add as a well-defined Python class or function. This makes the code reusable and easier to test.
Register a Command-Line Interface (CLI)
This is the most important step. To expose your functionality through the main
dockcommand, you must register your function inside the_cli.pyfile within your submodule directory.In this file, define your CLI command using the
clicklibrary and the provided@registerdecorator.
Example:
If you create deepx_dock/convert/fhi_aims/_cli.py with the following content:
import click
from pathlib import Path
from deepx_dock._cli.registry import register
@register(
cli_name="my-func",
cli_help="A brief description of what my-func does.",
cli_args=[
click.argument('fhiaims_dir', type=click.Path()),
click.argument('deeph_dir', type=click.Path()),
click.option(
'--jobs-num', '-j', type=int, default=-1,
help='Number of parallel workers (-1 for all cores)'
),
],
)
def my_func(fhiaims_dir: Path, deeph_dir: Path, jobs_num: int):
# Your implementation logic here
from .my_wonderful_function import my_real_func
my_real_func(fhiaims_dir, deeph_dir, n_jobs=jobs_num)
Then, on the user end, a new command will be available:
dock convert fhi-aims my-func
The command's usage (arguments, options, help text) is entirely defined by the click decorators specified in cli_args. Please refer to the official click documentation for details on defining arguments and options.
License
This project is licensed under the GPL 3.0 License - see the LICENSE file for details.
Support & Contact
- 📖 Documentation: Documentation Link
- 🐛 Issue Reporting: GitHub Issues
DeepH-dock is community-driven development for quantum materials calculations, aiming to promote openness and reproducibility in computational materials science research.