# MacroQueue: Automating Scanning Probe Microscopy
Scanning Probe Microscopy operators often use several different instruments for a single measurement; such as, an external lock-in amplifer, a power supply to create a magnetic field, a RF generator, etc.. Often, these intruments have to be manually controlled and then their parameters have to be manually recorded. MacroQueue is a modular software designed for controlling and automating SPM systems and various other laboratory equipment in sync. It provides a single GUI to control the 3 major commerical SPMs, CreaTec, RHK, and Scienta Omicron in combination with any other instruments that are apart of the systems.
Users can easily add python functions to control new and existing equipment. Although any arbitary python function can be added, the base functions were created with the functional programming paradigm in mind, so the functions are small and each perform a single task. For example, the function "Set RF Frequency", changes the frequency on the RF generator and records the new value. This allows the functions to be reused for many types of measurements.
The functions can be grouped into macros for each type of measurement. Macros are added to a queue with different values for each parameter (e.g. bias, magnetic field, etc.) to perform measurements throughout a parameter space. Each measurement is performed consecutively on a seperate thread to enable measurements in the queue to be modified.
These features allow users to easily control several instruments in sync, perform a long series of measurements with minimal input, and add new instruments to a system.
The goal of MacroQueue is to provide a GUI that allow users to perform measurements in high-dimensional parameter spaces without requiring coding ability while still providing users with coding ability the flexibility to write arbitrarily complex functions.
Check out for the [documentation](https://guptagroupstm.github.io/MacroQueue/index.html) for more information.
## Installation
See the [install documentation](https://guptagroupstm.github.io/MacroQueue/Install.html). System requirements are also found in this page.
## Contributing
Please read [documentation](https://guptagroupstm.github.io/MacroQueue/Contributing.html) for details on our code of conduct, and the process for submitting pull requests to us.
## Acknowledgements
MacroQueue was built by Brad Goff as part of the Gupta Group in the physics department at The Ohio State University. Visit our group’s website here: https://u.osu.edu/guptagroup/.
This work was primarily supported by the Department of Energy (DOE) Basic Energy Sciences under Grant No. DE-SC0016379.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
Raw data
{
"_id": null,
"home_page": "https://github.com/guptagroupstm/STMMacroQueue",
"name": "MacroQueue",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Automation, Scanning Probe Microscopy, Macro, Queue",
"author": "Brad Goff",
"author_email": "guptagroupstm@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f2/f7/4ae9048f18c8f44c19bea7f066598dda5dfb7a1e097f722bf5b7d40c47b8/MacroQueue-0.3.1.tar.gz",
"platform": null,
"description": "# MacroQueue: Automating Scanning Probe Microscopy\r\n\r\nScanning Probe Microscopy operators often use several different instruments for a single measurement; such as, an external lock-in amplifer, a power supply to create a magnetic field, a RF generator, etc.. Often, these intruments have to be manually controlled and then their parameters have to be manually recorded. MacroQueue is a modular software designed for controlling and automating SPM systems and various other laboratory equipment in sync. It provides a single GUI to control the 3 major commerical SPMs, CreaTec, RHK, and Scienta Omicron in combination with any other instruments that are apart of the systems. \r\n\r\n\r\nUsers can easily add python functions to control new and existing equipment. Although any arbitary python function can be added, the base functions were created with the functional programming paradigm in mind, so the functions are small and each perform a single task. For example, the function \"Set RF Frequency\", changes the frequency on the RF generator and records the new value. This allows the functions to be reused for many types of measurements.\r\n\r\nThe functions can be grouped into macros for each type of measurement. Macros are added to a queue with different values for each parameter (e.g. bias, magnetic field, etc.) to perform measurements throughout a parameter space. Each measurement is performed consecutively on a seperate thread to enable measurements in the queue to be modified.\r\nThese features allow users to easily control several instruments in sync, perform a long series of measurements with minimal input, and add new instruments to a system. \r\nThe goal of MacroQueue is to provide a GUI that allow users to perform measurements in high-dimensional parameter spaces without requiring coding ability while still providing users with coding ability the flexibility to write arbitrarily complex functions. \r\n\r\nCheck out for the [documentation](https://guptagroupstm.github.io/MacroQueue/index.html) for more information.\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n## Installation\r\n\r\nSee the [install documentation](https://guptagroupstm.github.io/MacroQueue/Install.html). System requirements are also found in this page.\r\n\r\n## Contributing\r\n\r\nPlease read [documentation](https://guptagroupstm.github.io/MacroQueue/Contributing.html) for details on our code of conduct, and the process for submitting pull requests to us.\r\n\r\n## Acknowledgements\r\n\r\nMacroQueue was built by Brad Goff as part of the Gupta Group in the physics department at The Ohio State University. Visit our group\u00e2\u20ac\u2122s website here: https://u.osu.edu/guptagroup/.\r\n\r\nThis work was primarily supported by the Department of Energy (DOE) Basic Energy Sciences under Grant No. DE-SC0016379.\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Automating Scanning Probe Microscopy",
"version": "0.3.1",
"project_urls": {
"Download": "https://github.com/guptagroupstm/STMMacroQueue/archive/refs/tags/v0.3.1.tar.gz",
"Homepage": "https://github.com/guptagroupstm/STMMacroQueue"
},
"split_keywords": [
"automation",
" scanning probe microscopy",
" macro",
" queue"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f2f74ae9048f18c8f44c19bea7f066598dda5dfb7a1e097f722bf5b7d40c47b8",
"md5": "1910d8a7919f8fd47f5c1db958a6a65d",
"sha256": "3c812f0f7f3bdb4a72bdda1cfb8d39ff4dcb72b13afa82b3fa81ec28553e1fd9"
},
"downloads": -1,
"filename": "MacroQueue-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "1910d8a7919f8fd47f5c1db958a6a65d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 257882,
"upload_time": "2024-04-08T15:50:42",
"upload_time_iso_8601": "2024-04-08T15:50:42.522678Z",
"url": "https://files.pythonhosted.org/packages/f2/f7/4ae9048f18c8f44c19bea7f066598dda5dfb7a1e097f722bf5b7d40c47b8/MacroQueue-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-08 15:50:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "guptagroupstm",
"github_project": "STMMacroQueue",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "macroqueue"
}
JSON
