Skip to content

Latest commit

 

History

History
96 lines (68 loc) · 4.74 KB

README.md

File metadata and controls

96 lines (68 loc) · 4.74 KB
Raw

DeePTB Logo

DeepModeling Build Test PyPI version License

🚀 About DeePTB

DeePTB is an innovative Python package that uses deep learning to accelerate ab initio electronic structure simulations. It offers versatile, accurate, and efficient simulations for a wide range of materials and phenomena. Trained on small systems, DeePTB can predict electronic structures of large systems, handle structural perturbations, and integrate with molecular dynamics for finite temperature simulations, providing comprehensive insights into atomic and electronic behavior.

  • Key Features DeePTB contains two main components:

    1. DeePTB-SK: deep learning based local environment dependent Slater-Koster TB.

      • Customizable Slater-Koster parameterization with neural network corrections for .
      • Flexible basis and exchange-correlation functional choices.
      • Handle systems with strong spin-orbit coupling (SOC) effects.

    2. DeePTB-E3: E3-equivariant neural networks for representing quantum operators.

      • Construct DFT Hamiltonians/density and overlap matrices under full LCAO basis.
      • Utilize (Strictly) Localized Equivariant Message-passing ((S)LEM) model for high data-efficiency and accuracy.
      • Employs SO(2) convolution for efficient handling of higher-order orbitals in LCAO basis.

For more details, see our papers:

🛠️ Installation

Installing DeePTB is straightforward. We recommend using a virtual environment for dependency management.

  • Requirements

    • Python 3.8 or later.
    • Torch 1.13.0 or later (PyTorch Installation).
    • ifermi (optional, for 3D fermi-surface plotting).

  • Easy Installation

    1. Using PyPi
    2. Ensure you have Python 3.8 or later and Torch installed.
    3. Install DeePTB with pip: 
      pip install dptb

  • From Source

    1. Clone the repository: 
      git clone https://github.com/deepmodeling/DeePTB.git
    2. Navigate to the root directory and install DeePTB: 
      cd DeePTB
pip install .

📚 Documentation

  • Online documentation

    For a comprehensive guide and usage tutorials, visit our documentation website.

  • Community

    DeePTB joins the DeepModeling community, a community devoted of AI for science, as an incubating level project. To learn more about the DeepModeling community, see the introduction of community.

  • Contributing

    We welcome contributions to DeePTB. Please refer to our contributing guidelines for details.

🤝 How to Cite

The following references are required to be cited when using DeePTB. Specifically:

  • For DeePTB-SK:

    Q. Gu, Z. Zhouyin, S. K. Pandey, P. Zhang, L. Zhang, and W. E, Deep Learning Tight-Binding Approach for Large-Scale Electronic Simulations at Finite Temperatures with Ab Initio Accuracy, Nat Commun 15, 6772 (2024).

  • For DeePTB-E3:

    Z. Zhouyin, Z. Gan, S. K. Pandey, L. Zhang, and Q. Gu, Learning Local Equivariant Representations for Quantum Operators, arXiv:2407.06053.