Skip to main content

Collection of automated STM and nc-AFM commands compatible with Nanonis V5 SPM Controller

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scanbot-4.5.1.tar.gz (52.5 MB view details)

Uploaded Source

Built Distribution

scanbot-4.5.1-py3-none-any.whl (52.5 MB view details)

Uploaded Python 3

File details

Details for the file scanbot-4.5.1.tar.gz.

File metadata

  • Download URL: scanbot-4.5.1.tar.gz
  • Upload date:
  • Size: 52.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for scanbot-4.5.1.tar.gz
Algorithm Hash digest
SHA256 b061de7f6f7cf1c7e7084684b860ace6b93a56e6ac32d0eace93fa5be2af4b3b
MD5 1f19a6ab35c0dd875efea1dc8a25e05e
BLAKE2b-256 ba8f80923a8a1c79448d3444cbeca034556e183448e40c55c00c6381c6901fae

See more details on using hashes here.

File details

Details for the file scanbot-4.5.1-py3-none-any.whl.

File metadata

  • Download URL: scanbot-4.5.1-py3-none-any.whl
  • Upload date:
  • Size: 52.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for scanbot-4.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 55c317fae526db3bc905d548b2b1284272dc2bb62abca75658db8e58a656b289
MD5 6db3dfaea4c0ca3429e5d63baa1db92c
BLAKE2b-256 7be3bd6de007f9beef19fe499c350261105042c3575150464d664949acc551c3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page