roboflo


Nameroboflo JSON
Version 0.2.1 PyPI version JSON
download
home_page
SummaryScheduler for automation tasks that involve multiple stations/workers.
upload_time2022-12-24 23:39:06
maintainer
docs_urlNone
authorRishi Kumar
requires_python
licenseMIT
keywords research science machine automation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/rekumar/roboflo/HEAD?labpath=.%2FExamples%2Fbasic%20usage.ipynb)
[![PyPI version](https://badge.fury.io/py/roboflo.svg)](https://badge.fury.io/py/roboflo)
[![codecov](https://codecov.io/gh/rekumar/roboflo/branch/master/graph/badge.svg?token=V3LPNLOJOG)](https://codecov.io/gh/rekumar/roboflo)

![roboflo](/docs/roboflo.png)

`pip install roboflo`

Task scheduler for any system with coordinated workers. The original use case is for the Perovskite Automated Spin-Coating Assembly Line (PASCAL) in the Fenning Lab at UC San Diego, where a robotic arm moves small glass slides between stations to perform experiments. 

`roboflo` assumes that you have a set of `Worker`'s that act (independently or in unison) to perform `Task`'s of set duration. Furthermore, one or more `Worker`'s can function to transition between `Task`'s (eg my robot moves a sample from the hotplate to a camera, or my mom moves me from school to soccer practice). These transition moves constitute a special case of `Task`'s , called `Transition`'s. The total set of `Worker`'s and `Transition`'s define your `System`. Sets of `Task`'s are consolidated into `Protocol`'s (eg the same process for five samples or five kids), which are then scheduled (using the `Scheduler` on your `System`) to minimize the total working time. An example schedule is shown below. 

Happy robot-ing!

![Example Schedule](/docs/exampleschedule.jpg)

PS - shoutout to [Taskpacker](https://github.com/Edinburgh-Genome-Foundry/Taskpacker), from which I drew heavy inspiration. `roboflo` carries much of the design philosophy from `Taskpacker`, but uses only Python packages (the backend is Google ORTools as opposed to Numberjack, which can be difficult to install especially on Windows). `roboflo` also introduces `Transitions`, which define a finite state machine, as a critical component in the workflow under the assumption that many robotic platforms involve workers whose specific jobs are to move things between other workers.




            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "roboflo",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "research,science,machine,automation",
    "author": "Rishi Kumar",
    "author_email": "rek010@eng.ucsd.edu",
    "download_url": "https://files.pythonhosted.org/packages/99/93/a50b2774b1432a7ff417f4ee6272cdcc9e19b03cd936ea2c721d62fcf723/roboflo-0.2.1.tar.gz",
    "platform": null,
    "description": "[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/rekumar/roboflo/HEAD?labpath=.%2FExamples%2Fbasic%20usage.ipynb)\n[![PyPI version](https://badge.fury.io/py/roboflo.svg)](https://badge.fury.io/py/roboflo)\n[![codecov](https://codecov.io/gh/rekumar/roboflo/branch/master/graph/badge.svg?token=V3LPNLOJOG)](https://codecov.io/gh/rekumar/roboflo)\n\n![roboflo](/docs/roboflo.png)\n\n`pip install roboflo`\n\nTask scheduler for any system with coordinated workers. The original use case is for the Perovskite Automated Spin-Coating Assembly Line (PASCAL) in the Fenning Lab at UC San Diego, where a robotic arm moves small glass slides between stations to perform experiments. \n\n`roboflo` assumes that you have a set of `Worker`'s that act (independently or in unison) to perform `Task`'s of set duration. Furthermore, one or more `Worker`'s can function to transition between `Task`'s (eg my robot moves a sample from the hotplate to a camera, or my mom moves me from school to soccer practice). These transition moves constitute a special case of `Task`'s , called `Transition`'s. The total set of `Worker`'s and `Transition`'s define your `System`. Sets of `Task`'s are consolidated into `Protocol`'s (eg the same process for five samples or five kids), which are then scheduled (using the `Scheduler` on your `System`) to minimize the total working time. An example schedule is shown below. \n\nHappy robot-ing!\n\n![Example Schedule](/docs/exampleschedule.jpg)\n\nPS - shoutout to [Taskpacker](https://github.com/Edinburgh-Genome-Foundry/Taskpacker), from which I drew heavy inspiration. `roboflo` carries much of the design philosophy from `Taskpacker`, but uses only Python packages (the backend is Google ORTools as opposed to Numberjack, which can be difficult to install especially on Windows). `roboflo` also introduces `Transitions`, which define a finite state machine, as a critical component in the workflow under the assumption that many robotic platforms involve workers whose specific jobs are to move things between other workers.\n\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Scheduler for automation tasks that involve multiple stations/workers.",
    "version": "0.2.1",
    "split_keywords": [
        "research",
        "science",
        "machine",
        "automation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "59a0d4bdcbf8db00ba5b72730152131f",
                "sha256": "4688216d1e6ad212ea9624ecda406539c50ae09e49756e30ae65e8e7d2055f16"
            },
            "downloads": -1,
            "filename": "roboflo-0.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "59a0d4bdcbf8db00ba5b72730152131f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 28723,
            "upload_time": "2022-12-24T23:39:05",
            "upload_time_iso_8601": "2022-12-24T23:39:05.298670Z",
            "url": "https://files.pythonhosted.org/packages/4d/1f/50d63c7bfa7aed4ebf9173be606048168cd1543cad1432b551a7a18cd98d/roboflo-0.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "4c26dcebcf9ebfcb63628f451feb2daf",
                "sha256": "325ae66f3b0315c2fb727bf1637bcc1b4e4b4b7ca191c58cc322aa59bbc141d3"
            },
            "downloads": -1,
            "filename": "roboflo-0.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "4c26dcebcf9ebfcb63628f451feb2daf",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 27121,
            "upload_time": "2022-12-24T23:39:06",
            "upload_time_iso_8601": "2022-12-24T23:39:06.862686Z",
            "url": "https://files.pythonhosted.org/packages/99/93/a50b2774b1432a7ff417f4ee6272cdcc9e19b03cd936ea2c721d62fcf723/roboflo-0.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-24 23:39:06",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "roboflo"
}
        
Elapsed time: 0.02330s