Update README.md
This commit is contained in:
parent
41a133a2ff
commit
d10d5aca75
27
README.md
27
README.md
@ -1,6 +1,27 @@
|
|||||||
### Guan: an open source python package. The official website is https://py.guanjihuan.com.
|
## Guan package
|
||||||
|
|
||||||
### Installation: pip install --upgrade guan
|
Guan is an open source python package, dealing with tight-binding models by calculating band structures, density of states, quantum transport, topological invariant, etc. Other trivial functions are also integrated, including file reading/writing, figure plotting, data processing. The official website is https://py.guanjihuan.com.
|
||||||
|
|
||||||
### Usage: import guan
|
## Installation
|
||||||
|
|
||||||
|
pip install --upgrade guan
|
||||||
|
|
||||||
|
## Usage:
|
||||||
|
|
||||||
|
import guan
|
||||||
|
|
||||||
|
## Summary of API Reference
|
||||||
|
|
||||||
|
+ basic functions
|
||||||
|
+ Fourier transform
|
||||||
|
+ Hamiltonian of finite size systems
|
||||||
|
+ Hamiltonian of models in the reciprocal space
|
||||||
|
+ band structures and wave functions
|
||||||
|
+ Green functions
|
||||||
|
+ density of states
|
||||||
|
+ quantum transport
|
||||||
|
+ topological invariant
|
||||||
|
+ read and write
|
||||||
|
+ plot figures
|
||||||
|
+ data processing
|
||||||
|
+ others
|
||||||
|
Loading…
x
Reference in New Issue
Block a user