stm_sim
An STM simulation python library from LDOS.
Installation
pip install -U stm-sim
Requirements
- ASE
- surface_construct
- Mayavi (optional)
Usage
from stm_sim.stm import STM
parchg_file = "PARCHG"
stm = STM(bias=(-0.1, 0.1))
stm.read_parchg(parchg_file)
x, y, z = stm.scan(scan_mode='constant_current', repeat=(2, 2), plot=True)
Parameters
scan_mode: default isconstant_current, supportconstant_heightandconstant_currentrepeat: repeat the simulated image along x,y axesplot: plot it with matplotlib or not, default isFalsestartpoint: set the start point to find height can save time, used forscan_mode='constant_current'.height:- The height for
scan_mode='constant_height'. - For
scan_mode='constant_current', it is for the height of tip to obtain the average current: h_tip = height + 0.76, 0.76 is the radius of carbon.- For
bottom=True, it use oldget_avg_current_from_height.
- For
- The height for
bottom: upper or bottom side of slab, default isFalse
TODO
- Export 2d data for external program plot.
- Generate INCAR for vasp task
- Support other program, like cp2k, fireball, fhi-aims, integrate multiwfn
- Use api design
- Autofocus method: height auto choose, current auto choose, bias auto choose
- 使用傅立叶变换,目标是主频频率需要满足特定的规则,需要扩包;黑白要分明,最好对半分;高度差要在一个范围里面,用户可定义
- 使用强化学习的方法,训练模型
- 可能得到多个不同的图样,返回最大差异的图样
- 默认频率的范围,用户可以手动确认
- 支持在台阶处的特殊处理
Metadata
Release files for stm-sim 0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| stm_sim-0.5.tar.gz | 10.4 kB | Without provenance | Details for stm_sim-0.5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| stm_sim-0.5-py3-none-any.whl | Python 3 | none | any | Details for stm_sim-0.5-py3-none-any.whl |
Total release size: 19.4 kB
Release files / stm_sim-0.5.tar.gz
| Download URL | stm_sim-0.5.tar.gz |
|---|---|
| Size | 10.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
534c77ffdd97900a91f7dfeed02eb1fbc80699d2ff79ca64260cdf4e76534f69
|
|
BLAKE2b-256 checksum How to use checksums |
8cacb87f146e58d56500434389ad26937fb10a163617b1dcc2d48eefc167bc2a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.10.10
|
Release files / stm_sim-0.5-py3-none-any.whl
| Download URL | stm_sim-0.5-py3-none-any.whl |
|---|---|
| Size | 9.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1b23eebed3098f070c9281ad9533fc4c4860ffa6036b79f62b300d6fef831edd
|
|
BLAKE2b-256 checksum How to use checksums |
1974cd1994a48534111d36d5834769854186797b48d55158ea279e6d6ecfc20e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.10.10
|
Security for stm-sim 0.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.