Update README.md
This commit is contained in:
parent
9e2cef302b
commit
2d213d7814
@ -2,7 +2,7 @@
|
||||
|
||||
Guan is an open-source python package developed and maintained by https://www.guanjihuan.com/about (Ji-Huan Guan, 关济寰). With this package, you can calculate band structures, density of states, quantum transport and topological invariant of tight-binding models by invoking the functions you need. Other frequently used functions are also integrated in this package, such as figure plotting, file-reading/writing, data processing, file processing.
|
||||
|
||||
The primary location of this package is on website https://py.guanjihuan.com.
|
||||
The primary location of this package is on https://py.guanjihuan.com.
|
||||
|
||||
## Installation
|
||||
|
||||
@ -25,8 +25,8 @@ import guan
|
||||
+ topological invariant
|
||||
+ plot figures
|
||||
+ read and write
|
||||
+ data processing
|
||||
+ file processing
|
||||
+ data processing
|
||||
|
||||
## About this package
|
||||
|
||||
@ -34,7 +34,6 @@ import guan
|
||||
+ All realizations of this package are based on functions without any class, which are concise and convenient. The boring document is omitted and you have to read the Source Code for details if it is necessary. Nevertheless, you don’t have to be worried about the difficulty, because all functions are simple enough without too many prejudgments and the variable names are written commonly as far as possible for the easy reading.
|
||||
+ Before the function calling in your project, you are recommended to briefly read the Source Code to know the specific formats of input and output about the function. Applying functions mechanically may cause errors. Notice that as the package is developed, the function names may be changed in the future version. Therefore, the latest API Reference is important and helpful.
|
||||
|
||||
|
||||
## Citation
|
||||
|
||||
There is no official paper related to this package temporarily, but you can cite one or all of the following papers instead which are the motivation of this project (e.g., calculating the scattering matrix), if this package is greatly helpful for your research.
|
||||
|
Loading…
x
Reference in New Issue
Block a user