{"id":22753776,"url":"https://github.com/slaclab/paws","last_synced_at":"2025-04-14T15:34:10.067Z","repository":{"id":57456249,"uuid":"81961187","full_name":"slaclab/paws","owner":"slaclab","description":"the Platform for Automated Workflows by SSRL","archived":false,"fork":false,"pushed_at":"2020-04-04T20:23:52.000Z","size":2518,"stargazers_count":2,"open_issues_count":0,"forks_count":5,"subscribers_count":15,"default_branch":"dev","last_synced_at":"2025-03-28T04:25:45.397Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/slaclab.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-02-14T15:45:52.000Z","updated_at":"2024-03-12T17:50:24.000Z","dependencies_parsed_at":"2022-09-14T05:11:25.489Z","dependency_job_id":null,"html_url":"https://github.com/slaclab/paws","commit_stats":null,"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slaclab%2Fpaws","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slaclab%2Fpaws/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slaclab%2Fpaws/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slaclab%2Fpaws/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/slaclab","download_url":"https://codeload.github.com/slaclab/paws/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248906436,"owners_count":21181177,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-12-11T06:13:07.727Z","updated_at":"2025-04-14T15:34:10.033Z","avatar_url":"https://github.com/slaclab.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"paws: the Platform for Automated Workflows by SSRL \n==================================================\n\n\nIntroduction\n------------\n\n`paws` stands for the Platform for Automated Workflows by SSRL.\nIt was conceived to serve as a lean and modular\nworkflow manager for scientific data.\n\n`paws` interfaces with an ever-growing number of packages \nand provides for users to add their own Operations,\nby writing isolated Python modules following a simple template.\n\nThe essential ingredients of `paws` are Operations, Workflows, and Plugins.\nA `paws` Operation is meant to take some inputs and produce some outputs-\nit is essentially  a function, wrapped in a class, wrapped in a Python module.\nThe class and module layers are used for certain conveniences \nin the implementation of `paws` Workflows.\nA `paws` Plugin is an object that should persist over time\nto repeatedly execute one or more activities,\nfor example to monitor an experimental apparatus,\nor to expose functionalities of a complex object for Operations to use.\nA `paws` Workflow contains the logic necessary for stitching together Operations and Plugins,\nand despite the distinction in name, it implements the same interface as an Operation.\n\nDisclaimer: `paws` is neither the first nor the most sophisticated\nway to build and manage data processing workflows.\nIts development was driven by a need\nfor modularity and extensibility,\nfor rapid development and deployment \nof stand-alone applications for a wide variety of experimental control\nand data processing tasks.\n\n\nDocumentation\n-------------\n\nThe documentation for `paws` is hosted by readthedocs.org:\n`http://paws.readthedocs.io/en/latest/`.\nThis documentation is continually under development.\nPlease contact the developers at `paws-developers@slac.stanford.edu`\nif the documentation fails to answer your questions.\n\n\nAPI Examples\n------------\n\nThe following are examples that explore \nthe capabilities of the `paws` API.\n\nTODO: write new examples\n\n\nInstallation\n------------\n\nNOTE: all deployments are currently outdated or under heavy development.\nPlease contact the development team if you are interested in this package.\n\n`paws` is available on PyPI and Anaconda.\nDeployments to PyPI are performed regularly.\nCurrently, we only deploy relatively stable versions to Anaconda.\n\nTo install from PyPI, invoke `pip`:\n`pip install pypaws`.\n\nTo install from Anaconda, use `conda`:\n`conda install -c ssrl-paws pypaws` \n\nAll of the dependencies of the `paws` Operations \nare not necessarily declared as dependencies of `paws`.\nThis keeps the Python environment relatively lean\nand avoids obnoxious installation overhead,\nbut it means that users will have to prepare their\nenvironments for the Operations they want to use.\n\nThe documentation of `paws` includes instructions\nfor installing the dependencies of each Operation.\nNOTE: this is currently false. \n\n\nAttribution\n-----------\n\n`paws` was written at SSRL by Chris Tassone's research group.\nIf you use `paws` in your published research, \na citation would be appreciated.\n\nBefore citing `paws`, it is of primary importance that you cite \nthe authors of the original work that produced your results: \nthis is almost certainly separate from the authors of `paws`.\nCitations for your specific Operations should be found\nin the `paws` documentation.\nIf you have trouble finding proper citations,\nplease contact us at `paws-developers@slac.stanford.edu`,\nand we will do our best to help.\n\n\nContribution\n------------\n\nContribution to `paws` is encouraged and appreciated.\nGet in touch with the `paws` development team\nat `paws-developers@slac.stanford.edu`.\nIf you are able to develop without assistance,\nfeel free to submit a pull request against the `dev` branch at\nhttps://github.com/slaclab/paws.\n\n\nLicense\n-------\n\nThe 3-clause BSD-like license attached to this software \ncan be found in the LICENSE file in the source code root directory.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslaclab%2Fpaws","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fslaclab%2Fpaws","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslaclab%2Fpaws/lists"}