Metadata-Version: 2.1
Name: scanbot
Version: 4.4.2
Summary: Collection of automated STM and nc-AFM commands compatible with Nanonis V5 SPM Controller
License: MIT
Keywords: stm,automation,python,scanning tunnelling microscopy,sts,scanbot
Author: Julian Ceddia
Author-email: jdceddia@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: flask
Requires-Dist: flask-cors
Requires-Dist: matplotlib
Requires-Dist: nanonisTCP (>1.1.1)
Requires-Dist: numpy
Requires-Dist: opencv-python (<4.9.0.81)
Requires-Dist: panel
Requires-Dist: pytest
Requires-Dist: scipy
Requires-Dist: zulip
Description-Content-Type: text/markdown

# V4 Update!
Scanbot has been implemented as a web application using [React](https://react.dev/).
    
On Windows, the easiest way to use it is by downloading the <a href="https://scanbot-46390.web.app" target="_blank">executable</a>.

Alternatively, Scanbot can be installed via ```pip install scanbot``` and launched with ```scanbot```
    
Full documentation available [here](https://new-horizons-spm.github.io/scanbot/web-app/).

# Scanbot       [![DOI](https://zenodo.org/badge/487719232.svg)](https://zenodo.org/badge/latestdoi/487719232)

Scanbot is a collection of several automated STM and nc-AFM data acquisition commands compatible with Nanonis V5 SPM control software.
Full documentation available [here](https://new-horizons-spm.github.io/scanbot/).

### Functional Overview
* STM
    - Bias dependent imaging with drift correction
    - Automated sample surveying (NxN grid)
* STS
    - STS Grids with drift correction
* nc-AFM
    - 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.

## Contributing

If you wish to contribute to Scanbot in any way, please refer to [these guidlines](https://new-horizons-spm.github.io/scanbot/#contributing).

## Citing

If you use Scanbot in your scientific research, please consider [citing it](https://zenodo.org/badge/latestdoi/487719232).

## FLEET
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.).

