Scanbot
Scanbot: An STM Automation Bot - Published in JOSS (2024)
Science Score: 100.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 8 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org -
✓Committers with academic emails
1 of 2 committers (50.0%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Keywords
Scientific Fields
Repository
STM Automation Bot
Basic Info
Statistics
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 0
- Releases: 6
Topics
Metadata Files
README.md
Scanbot 
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.
Owner
- Name: New-Horizons-SPM
- Login: New-Horizons-SPM
- Kind: organization
- Repositories: 5
- Profile: https://github.com/New-Horizons-SPM
JOSS Publication
Scanbot: An STM Automation Bot
Authors
School of Physics & Astronomy, Monash University, Clayton, Victoria 3800, Australia, ARC Centre of Excellence in Future Low-Energy Electronics Technologies, Monash University, Clayton, Victoria 3800, Australia
School of Physics & Astronomy, Monash University, Clayton, Victoria 3800, Australia, ARC Centre of Excellence in Future Low-Energy Electronics Technologies, Monash University, Clayton, Victoria 3800, Australia
School of Physics & Astronomy, Monash University, Clayton, Victoria 3800, Australia, ARC Centre of Excellence in Future Low-Energy Electronics Technologies, Monash University, Clayton, Victoria 3800, Australia
School of Physics & Astronomy, Monash University, Clayton, Victoria 3800, Australia, ARC Centre of Excellence in Future Low-Energy Electronics Technologies, Monash University, Clayton, Victoria 3800, Australia
Editor
Bonan Zhu
Tags
Python Scanning Tunneling Microscopy STM AutomationCitation (CITATION.cff)
cff-version: "1.2.0"
authors:
- family-names: Ceddia
given-names: Julian
orcid: "https://orcid.org/0000-0003-3990-8852"
- family-names: Hellerstedt
given-names: Jack
orcid: "https://orcid.org/0000-0003-2282-8223"
- family-names: Lowe
given-names: Benjamin
orcid: "https://orcid.org/0000-0002-5157-7737"
- family-names: Schiffrin
given-names: Agustin
orcid: "https://orcid.org/0000-0003-1140-8485"
contact:
- family-names: Ceddia
given-names: Julian
orcid: "https://orcid.org/0000-0003-3990-8852"
doi: 10.5281/zenodo.12669343
message: If you use this software, please cite our article in the
Journal of Open Source Software.
preferred-citation:
authors:
- family-names: Ceddia
given-names: Julian
orcid: "https://orcid.org/0000-0003-3990-8852"
- family-names: Hellerstedt
given-names: Jack
orcid: "https://orcid.org/0000-0003-2282-8223"
- family-names: Lowe
given-names: Benjamin
orcid: "https://orcid.org/0000-0002-5157-7737"
- family-names: Schiffrin
given-names: Agustin
orcid: "https://orcid.org/0000-0003-1140-8485"
date-published: 2024-07-15
doi: 10.21105/joss.06028
issn: 2475-9066
issue: 99
journal: Journal of Open Source Software
publisher:
name: Open Journals
start: 6028
title: "Scanbot: An STM Automation Bot"
type: article
url: "https://joss.theoj.org/papers/10.21105/joss.06028"
volume: 9
title: "Scanbot: An STM Automation Bot"
GitHub Events
Total
- Watch event: 2
Last Year
- Watch event: 2
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| ceds92 | j****a@m****u | 231 |
| jhellerstedt | h****k@g****m | 39 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 8
- Total pull requests: 26
- Average time to close issues: about 1 month
- Average time to close pull requests: about 1 month
- Total issue authors: 2
- Total pull request authors: 3
- Average comments per issue: 1.13
- Average comments per pull request: 0.0
- Merged pull requests: 21
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- ceds92 (8)
- jhellerstedt (1)
Pull Request Authors
- ceds92 (33)
- kyleniemeyer (2)
- jhellerstedt (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 24 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 7
- Total maintainers: 1
pypi.org: scanbot
Collection of automated STM and nc-AFM commands compatible with Nanonis V5 SPM Controller
- Documentation: https://scanbot.readthedocs.io/
- License: MIT
-
Latest release: 4.5.1
published over 1 year ago
Rankings
Maintainers (1)
Dependencies
- matplotlib *
- numpy *
- opencv-python *
- scipy *
- zulip *