{"id":37078281,"url":"https://github.com/new-horizons-spm/scanbot","last_synced_at":"2026-01-14T09:04:53.606Z","repository":{"id":37684908,"uuid":"487719232","full_name":"New-Horizons-SPM/scanbot","owner":"New-Horizons-SPM","description":"STM Automation Bot","archived":false,"fork":false,"pushed_at":"2024-07-21T01:05:52.000Z","size":31487,"stargazers_count":8,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"V4","last_synced_at":"2025-12-15T22:14:56.189Z","etag":null,"topics":["automation","nanonis","nanonistcp","nc-afm","python","scanbot","spm","stm"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/New-Horizons-SPM.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-05-02T04:49:24.000Z","updated_at":"2025-09-24T20:47:16.000Z","dependencies_parsed_at":"2023-01-23T06:15:29.359Z","dependency_job_id":"844113e1-5840-4a7e-84f8-2847358b8989","html_url":"https://github.com/New-Horizons-SPM/scanbot","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/New-Horizons-SPM/scanbot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/New-Horizons-SPM%2Fscanbot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/New-Horizons-SPM%2Fscanbot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/New-Horizons-SPM%2Fscanbot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/New-Horizons-SPM%2Fscanbot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/New-Horizons-SPM","download_url":"https://codeload.github.com/New-Horizons-SPM/scanbot/tar.gz/refs/heads/V4","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/New-Horizons-SPM%2Fscanbot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28414740,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T08:38:59.149Z","status":"ssl_error","status_checked_at":"2026-01-14T08:38:43.588Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","nanonis","nanonistcp","nc-afm","python","scanbot","spm","stm"],"created_at":"2026-01-14T09:04:52.874Z","updated_at":"2026-01-14T09:04:53.601Z","avatar_url":"https://github.com/New-Horizons-SPM.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Scanbot       \u003ca href=\"https://new-horizons-spm.github.io/scanbot/\"\u003e\u003cimg alt=\"Static Badge\" src=\"https://img.shields.io/badge/documentation-mkdocs-00adff?logo=GitBook\u0026logoColor=white\"\u003e\u003c/a\u003e [![DOI](https://joss.theoj.org/papers/10.21105/joss.06028/status.svg)](https://doi.org/10.21105/joss.06028) \n\n\nScanbot 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).\n\n\u003cstrong\u003eFull documentation available [here](https://new-horizons-spm.github.io/scanbot/web-app/).\u003c/strong\u003e\n\n## Functional Overview\n* STM\n    - Bias dependent imaging with drift correction\n    - Automated sample surveying (NxN grid)\n* STS\n    - STS Grids with drift correction\n* nc-AFM (coming soon in the web app version)\n    - z-dependent nc-AFM\n    - nc-AFM registration\n* Automation\n    - Tip shaping\n    - Full control over the course motors\n* Hooks\n    - Scanbot has a number of built-in [hooks](https://new-horizons-spm.github.io/scanbot/hooks/) to let you customise key functionality.\n\n## Quick Start\n### Download and Run on Windows\nOn Windows, you can download and run the \u003ca href=\"https://scanbot-46390.web.app\" target=\"_blank\"\u003eScanbot executable\u003c/a\u003e.\n\n### Install with pip\nAlternatively, Scanbot can be installed with pip:\n\n```pip install scanbot```\n\n#### Launch as a Web Application\nTo launch Scanbot as a web application, run:\n\n```scanbot```\n\nIt should automatically open and run in a new browser tab. If it doesn't, head to http://127.0.0.1:5000.\n\n#### Launch in Console Mode\nYou can launch Scanbot in a console mode with the -c option:\n\n```scanbot -c```\n\nIn console mode, run ```help``` to see a full list of commands. To get help with a specific command, run ```help \u003ccommand name\u003e```\n\nFor more details, refer to the [documentation](https://new-horizons-spm.github.io/scanbot/)\n\n## Contributing\n\nIf you wish to contribute to Scanbot in any way, please refer to [these guidleines](https://new-horizons-spm.github.io/scanbot/#contributing).\n\n## Citing\n\n### APA\n```\nCeddia, J., Hellerstedt, J., Lowe, B., \u0026 Schiffrin, A. (2024). Scanbot: An STM Automation Bot. Journal of Open Source Software, 9(99), 6028. https://doi.org/10.21105/joss.06028\n```\n\n### BibTeX\n```\n@article{Ceddia_Scanbot_An_STM_2024,\nauthor = {Ceddia, Julian and Hellerstedt, Jack and Lowe, Benjamin and Schiffrin, Agustin},\ndoi = {10.21105/joss.06028},\njournal = {Journal of Open Source Software},\nmonth = jul,\nnumber = {99},\npages = {6028},\ntitle = {{Scanbot: An STM Automation Bot}},\nurl = {https://joss.theoj.org/papers/10.21105/joss.06028},\nvolume = {9},\nyear = {2024}\n}\n```\n\n## Acknowledgements\nSpecial 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.).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnew-horizons-spm%2Fscanbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnew-horizons-spm%2Fscanbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnew-horizons-spm%2Fscanbot/lists"}