https://github.com/new-horizons-spm/scanbot
STM Automation Bot
https://github.com/new-horizons-spm/scanbot
automation nanonis nanonistcp nc-afm python scanbot spm stm
Last synced: 6 months ago
JSON representation
STM Automation Bot
- Host: GitHub
- URL: https://github.com/new-horizons-spm/scanbot
- Owner: New-Horizons-SPM
- License: mit
- Created: 2022-05-02T04:49:24.000Z (about 4 years ago)
- Default Branch: V4
- Last Pushed: 2024-07-21T01:05:52.000Z (almost 2 years ago)
- Last Synced: 2025-12-15T22:14:56.189Z (7 months ago)
- Topics: automation, nanonis, nanonistcp, nc-afm, python, scanbot, spm, stm
- Language: Python
- Homepage:
- Size: 30 MB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
# Scanbot 
[](https://doi.org/10.21105/joss.06028)
Scanbot is a collection of several automated STM and nc-AFM data acquisition commands compatible with Nanonis V5 and V5e SPM control software (stable with R12280 and later).
Full documentation available [here](https://new-horizons-spm.github.io/scanbot/web-app/).
## Functional Overview
* STM
- Bias dependent imaging with drift correction
- Automated sample surveying (NxN grid)
* STS
- STS Grids with drift correction
* nc-AFM (coming soon in the web app version)
- z-dependent nc-AFM
- nc-AFM registration
* Automation
- Tip shaping
- Full control over the course motors
* Hooks
- Scanbot has a number of built-in [hooks](https://new-horizons-spm.github.io/scanbot/hooks/) to let you customise key functionality.
## Quick Start
### Download and Run on Windows
On Windows, you can download and run the Scanbot executable.
### Install with pip
Alternatively, Scanbot can be installed with pip:
```pip install scanbot```
#### Launch as a Web Application
To launch Scanbot as a web application, run:
```scanbot```
It should automatically open and run in a new browser tab. If it doesn't, head to http://127.0.0.1:5000.
#### Launch in Console Mode
You can launch Scanbot in a console mode with the -c option:
```scanbot -c```
In console mode, run ```help``` to see a full list of commands. To get help with a specific command, run ```help ```
For more details, refer to the [documentation](https://new-horizons-spm.github.io/scanbot/)
## Contributing
If you wish to contribute to Scanbot in any way, please refer to [these guidleines](https://new-horizons-spm.github.io/scanbot/#contributing).
## Citing
### APA
```
Ceddia, J., Hellerstedt, J., Lowe, B., & Schiffrin, A. (2024). Scanbot: An STM Automation Bot. Journal of Open Source Software, 9(99), 6028. https://doi.org/10.21105/joss.06028
```
### BibTeX
```
@article{Ceddia_Scanbot_An_STM_2024,
author = {Ceddia, Julian and Hellerstedt, Jack and Lowe, Benjamin and Schiffrin, Agustin},
doi = {10.21105/joss.06028},
journal = {Journal of Open Source Software},
month = jul,
number = {99},
pages = {6028},
title = {{Scanbot: An STM Automation Bot}},
url = {https://joss.theoj.org/papers/10.21105/joss.06028},
volume = {9},
year = {2024}
}
```
## Acknowledgements
Special thanks to [FLEET](https://www.fleet.org.au/) for their contribution through the [FLEET Translation Program](https://www.fleet.org.au/translation/#:~:text=A%20new%20FLEET%20program%20provides,translation%20skills%20in%20Centre%20membership.).