Skip to content

Commit

Permalink
Update Readme add deeptb-logo (#219)
Browse files Browse the repository at this point in the history
* Update README.md with logo and badge enhancements

* Enhance README.md with new section headers and improved formatting

* Improve formatting in README.md for better readability
  • Loading branch information
QG-phy authored Dec 23, 2024
1 parent 5307de2 commit d05c41d
Show file tree
Hide file tree
Showing 2 changed files with 132 additions and 47 deletions.
109 changes: 62 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,38 @@
# DeePTB

<p align="center">
<img src="docs/deeptb-logo.svg" alt="DeePTB Logo">
</p>

<!-- <h1 align="center">DeePTB</h1> -->

<!--# DeePTB -->
<p align="center">
<a href="https://github.com/deepmodeling"><img src="https://img.shields.io/badge/DeepModeling-Incubating_Project-blue" alt="DeepModeling"></a>
<a href="https://github.com/deepmodeling/DeePTB/actions/workflows/image.yml"><img src="https://github.com/deepmodeling/DeePTB/actions/workflows/image.yml/badge.svg" alt="Build"></a>
<a href="https://github.com/deepmodeling/DeePTB/actions/workflows/unit_test.yml"><img src="https://github.com/deepmodeling/DeePTB/actions/workflows/unit_test.yml/badge.svg" alt="Test"></a>
<a href="https://pypi.org/project/dptb/"><img src="https://img.shields.io/pypi/v/dptb.svg" alt="PyPI version"></a>
<a href="https://github.com/deepmodeling/DeePTB/blob/main/LICENSE"><img src="https://img.shields.io/github/license/deepmodeling/DeePTB.svg" alt="License"></a>
</p>

<!--
[![DeepModeling](https://img.shields.io/badge/DeepModeling-Incubating_Project-blue)](https://github.com/deepmodeling)
[![Build](https://github.com/deepmodeling/DeePTB/actions/workflows/image.yml/badge.svg)](https://github.com/deepmodeling/DeePTB/actions/workflows/image.yml)
[![Test](https://github.com/deepmodeling/DeePTB/actions/workflows/unit_test.yml/badge.svg)](https://github.com/deepmodeling/DeePTB/actions/workflows/unit_test.yml)
-->

## About DeePTB
## 🚀 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:
- **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.
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.

1. **DeePTB-E3**: E3-equivariant neural networks for representing quantum operators.
- Construct DFT Hamiltonians/density and overlap matrices under full LCAO basis.
- Utilize (**S**trictly) **L**ocalized **E**quivariant **M**essage-passing (**(S)LEM**) model for high data-efficiency and accuracy.
- Employs SO(2) convolution for efficient handling of higher-order orbitals in LCAO basis.
2. **DeePTB-E3**: E3-equivariant neural networks for representing quantum operators.
- Construct DFT Hamiltonians/density and overlap matrices under full LCAO basis.
- Utilize (**S**trictly) **L**ocalized **E**quivariant **M**essage-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:
Expand All @@ -27,49 +41,50 @@ For more details, see our papers:



## Installation
## 🛠️ 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](https://pytorch.org/get-started/locally)).
- ifermi (optional, for 3D fermi-surface plotting).

### Installation Steps

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

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

## Usage
For a comprehensive guide and usage tutorials, visit [our documentation website](https://deeptb.readthedocs.io/en/latest/).

- **Requirements**
- Python 3.8 or later.
- Torch 1.13.0 or later ([PyTorch Installation](https://pytorch.org/get-started/locally)).
- 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:
```bash
pip install dptb
```

- **From Source**
1. Clone the repository:
```bash
git clone https://github.com/deepmodeling/DeePTB.git
```
2. Navigate to the root directory and install DeePTB:
```bash
cd DeePTB
pip install .
```

## 📚 Documentation

- **Online documentation**

For a comprehensive guide and usage tutorials, visit [our documentation website](https://deeptb.readthedocs.io/en/latest/).

- **Community**

## 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](https://github.com/deepmodeling/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](https://github.com/deepmodeling/community).
- **Contributing**

## Contributing
We welcome contributions to **DeePTB**. Please refer to our [contributing guidelines](https://deeptb.readthedocs.io/en/latest/community/contribution_guide.html) for details.
We welcome contributions to DeePTB. Please refer to our [contributing guidelines](https://deeptb.readthedocs.io/en/latest/community/contribution_guide.html) for details.


## How to Cite
## 🤝 How to Cite

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

Expand Down
70 changes: 70 additions & 0 deletions docs/deeptb-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d05c41d

Please sign in to comment.