Skip to main content

Scanbot 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

If you use Scanbot in your scientific research, please consider citing it.

FLEET

Special thanks to FLEET for their contribution through the FLEET Translation Program.

Metadata

Release files for scanbot 4.5.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for scanbot 4.5.1
File Size Uploaded
scanbot-4.5.1.tar.gz 52.5 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for scanbot 4.5.1
File Interpreter ABI Platform
scanbot-4.5.1-py3-none-any.whl Python 3 none any Details

Total release size: 105.1 MB

Release files / scanbot-4.5.1.tar.gz

Download URL scanbot-4.5.1.tar.gz
Size 52.5 MB
Tags Source
SHA-256 checksum
How to use checksums
b061de7f6f7cf1c7e7084684b860ace6b93a56e6ac32d0eace93fa5be2af4b3b
BLAKE2b-256 checksum
How to use checksums
ba8f80923a8a1c79448d3444cbeca034556e183448e40c55c00c6381c6901fae
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.2

Release files / scanbot-4.5.1-py3-none-any.whl

Download URL scanbot-4.5.1-py3-none-any.whl
Size 52.5 MB
Tags Python 3
SHA-256 checksum
How to use checksums
55c317fae526db3bc905d548b2b1284272dc2bb62abca75658db8e58a656b289
BLAKE2b-256 checksum
How to use checksums
7be3bd6de007f9beef19fe499c350261105042c3575150464d664949acc551c3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.2

Release history Release notifications | RSS feed

This release

4.5.1 This release

2 release files

4.5.0

2 release files

4.4.2

2 release files

4.4.0

2 release files

4.3.0

2 release files

4.2.0

2 release files

4.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page