Skip to content

Commit 9d7a362

Browse files
committed
Make pretty (interfaces/, tools/)
1 parent a535f15 commit 9d7a362

258 files changed

Lines changed: 26530 additions & 23964 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

interfaces/ASE_interface/DEVELOP.md

Lines changed: 36 additions & 34 deletions
Large diffs are not rendered by default.

interfaces/ASE_interface/README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,18 @@
22

33
## Introduction
44

5-
abacuslite is a lightweight plugin for ABACUS (Atomic-orbital Based Ab-initio Computation at UStc), implementing the ASE (Atomic Simulation Environment) calculator interface.
5+
abacuslite is a lightweight plugin for ABACUS (Atomic-orbital Based Ab-initio Computation at UStc),
6+
implementing the ASE (Atomic Simulation Environment) calculator interface.
67

78
### Key Features
89

910
- **Lightweight Design**: Implemented as a plugin, no need to modify ASE core code
10-
- **Version Compatibility**: No longer restricted to specific ASE versions, works with most ASE versions
11-
- **ASE Integration**: Uses ASE as the running platform, making ABACUS a callable calculator within it
12-
- **Function Support**: Currently only supports SCF (Self-Consistent Field) functionality, returning energy, forces, stress, etc.
11+
- **Version Compatibility**: No longer restricted to specific ASE versions, works with most ASE
12+
versions
13+
- **ASE Integration**: Uses ASE as the running platform, making ABACUS a callable calculator within
14+
it
15+
- **Function Support**: Currently only supports SCF (Self-Consistent Field) functionality, returning
16+
energy, forces, stress, etc.
1317

1418
## Installation
1519

@@ -24,14 +28,14 @@ pip install .
2428
Please refer to the example scripts in the `examples` folder. Recommended learning path:
2529

2630
1. **scf.py** - Basic SCF calculation example
27-
2. **relax.py** - Atomic position relaxation calculation
28-
3. **cellrelax.py** - Cell parameter relaxation calculation
29-
4. **bandstructure.py** - Band structure calculation
30-
5. **dos.py** - Density of states calculation
31-
6. **md.py** - Molecular dynamics simulation
32-
7. **constraintmd.py** - Constrained molecular dynamics simulation
33-
8. **metadynamics.py** - Metadynamics simulation
34-
9. **neb.py** - Nudged Elastic Band (NEB) calculation
31+
1. **relax.py** - Atomic position relaxation calculation
32+
1. **cellrelax.py** - Cell parameter relaxation calculation
33+
1. **bandstructure.py** - Band structure calculation
34+
1. **dos.py** - Density of states calculation
35+
1. **md.py** - Molecular dynamics simulation
36+
1. **constraintmd.py** - Constrained molecular dynamics simulation
37+
1. **metadynamics.py** - Metadynamics simulation
38+
1. **neb.py** - Nudged Elastic Band (NEB) calculation
3539

3640
More usage examples will be provided in future versions.
3741

@@ -54,4 +58,4 @@ Thanks to the ABACUS development team for their support and contributions.
5458

5559
If you have any questions or suggestions, please contact us through:
5660

57-
- GitHub: [deepmodeling/abacus-develop](https://github.com/deepmodeling/abacus-develop)
61+
- GitHub: [deepmodeling/abacus-develop](https://github.com/deepmodeling/abacus-develop)
Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
'''
1+
"""
22
interfaces to Atomic-orbital Based Ab-initio Computation at UStc (ABACUS),
3-
for more information about this DFT calculator,
3+
for more information about this DFT calculator,
44
please refer to the Github official repository:
55
https://github.com/deepmodeling/abacus-develop
66
and online-manual:
@@ -9,5 +9,6 @@
99
For a more complete ABACUS pre-/post-processing workflow package,
1010
please refer to the ABACUSTest package:
1111
https://github.com/pxlxingliang/abacus-test
12-
'''
13-
from .core import *
12+
"""
13+
14+
from .core import *

interfaces/ASE_interface/abacuslite/core.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -633,4 +633,4 @@ def test_restart(self):
633633
self.assertAlmostEqual(e2, e)
634634

635635
if __name__ == '__main__':
636-
unittest.main()
636+
unittest.main()

0 commit comments

Comments
 (0)