Skip to content

New-Horizons-SPM/scanbot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Scanbot Static Badge DOI

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.

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 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 <command name>

For more details, refer to the documentation

Contributing

If you wish to contribute to Scanbot in any way, please refer to these guidleines.

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 for their contribution through the FLEET Translation Program.