| Name | intersect-sdk JSON |
| Version |
0.8.0
JSON |
| download |
| home_page | None |
| Summary | Python SDK to interact with INTERSECT |
| upload_time | 2024-09-11 01:39:30 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4.0,>=3.8.10 |
| license | BSD-3-Clause |
| keywords |
intersect
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# INTERSECT-SDK
The INTERSECT-SDK is a framework for microservices to integrate themselves into the wider Interconnected Science Ecosystem (INTERSECT).
Please note that this README is currently a work in progress.
## What is INTERSECT?
[INTERSECT](https://www.ornl.gov/intersect) was designed as a specific usecase - as an open federated hardware/software architecture for the laboratory of the future, which connects scientific instruments, robot-controlled laboratories and edge/center computing/data resources to enable autonomous experiments, self-driving laboratories, smart manufacturing, and AI-driven design, discovery and evaluation.
## What are the core design philosophies of the SDK?
- Event-driven architecture
- Support core interaction types: request/response, events, commands, statuses
- Borrows several concepts from [AsyncAPI](https://www.asyncapi.com/docs/reference/specification/latest), and intends to support multiple different protocols. Currently, we support MQTT 3.1.1 and AMQP 0.9.1, but other protocols will be supported as well.
- Users automatically generate schema from code; schemas are part of the core contract of an INTERSECT microservice, and both external inputs and microservice outputs are required to uphold this contract.
## Authors
INTERSECT SDK was created by its [contributors](https://github.com/intersect-sdk/python-sdk/graphs/contributors).
### Citing INTERSECT-SDK
If you are referencing INTERSECT-SDK in a publication, please cite the following paper:
* Addi Malviya Thakur, Seth Hitefield, Marshall McDonnell, Matthew Wolf, Richard Archibald, Lance Drane, Kevin Roccapriore, Maxim Ziatdinov, Jesse McGaha, Robert Smith, John Hetrick, Mark Abraham, Sergey Yakubov, Greg Watson, Ben Chance, Clara Nguyen, Matthew Baker, Robert Michael, Elke Arenholz & Ben Mintz. Towards a Software Development Framework for Interconnected Science Ecosystems. In: Doug, K., Al, G., Pophale, S., Liu, H., Parete-Koon, S. (eds) Accelerating Science and Engineering Discoveries Through Integrated Research Infrastructure for Experiment, Big Data, Modeling and Simulation. SMC 2022. Communications in Computer and Information Science, vol 1690. Springer, Cham. https://doi.org/10.1007/978-3-031-23606-8_13
On GitHub, you can copy this citation in APA or BibTeX format via the "Cite this repository" button. Or, see the comments in `CITATION.cff` for the raw BibTeX.
## Acknowledgements
The INTERSECT-SDK development has received funding support / sponsorship from the following:
* Laboratory Directed Research and Development Program of Oak Ridge National Laboratory, managed by UT-Battelle, LLC, for the U. S. Department of Energy.
Raw data
{
"_id": null,
"home_page": null,
"name": "intersect-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8.10",
"maintainer_email": null,
"keywords": "intersect",
"author": null,
"author_email": "Lance Drane <dranelt@ornl.gov>, Marshall McDonnell <mcdonnellmt@ornl.gov>, Seth Hitefield <hitefieldsd@ornl.gov>, Andrew Ayres <ayresaf@ornl.gov>, Gregory Cage <cagege@ornl.gov>, Jesse McGaha <mcgahajr@ornl.gov>, Robert Smith <smithrw@ornl.gov>, Gavin Wiggins <wigginsg@ornl.gov>, Michael Brim <brimmj@ornl.gov>, Rick Archibald <archibaldrk@ornl.gov>, Addi Malviya Thakur <malviyaa@ornl.gov>",
"download_url": "https://files.pythonhosted.org/packages/28/c1/04432b46a37b1cc391ae0796eaee26f15bd18ae989dd329a76b1540ae2c3/intersect_sdk-0.8.0.tar.gz",
"platform": null,
"description": "# INTERSECT-SDK\n\nThe INTERSECT-SDK is a framework for microservices to integrate themselves into the wider Interconnected Science Ecosystem (INTERSECT).\n\nPlease note that this README is currently a work in progress.\n\n## What is INTERSECT?\n[INTERSECT](https://www.ornl.gov/intersect) was designed as a specific usecase - as an open federated hardware/software architecture for the laboratory of the future, which connects scientific instruments, robot-controlled laboratories and edge/center computing/data resources to enable autonomous experiments, self-driving laboratories, smart manufacturing, and AI-driven design, discovery and evaluation.\n\n## What are the core design philosophies of the SDK?\n\n- Event-driven architecture\n- Support core interaction types: request/response, events, commands, statuses\n- Borrows several concepts from [AsyncAPI](https://www.asyncapi.com/docs/reference/specification/latest), and intends to support multiple different protocols. Currently, we support MQTT 3.1.1 and AMQP 0.9.1, but other protocols will be supported as well.\n- Users automatically generate schema from code; schemas are part of the core contract of an INTERSECT microservice, and both external inputs and microservice outputs are required to uphold this contract.\n\n## Authors\n\nINTERSECT SDK was created by its [contributors](https://github.com/intersect-sdk/python-sdk/graphs/contributors).\n\n### Citing INTERSECT-SDK\n\nIf you are referencing INTERSECT-SDK in a publication, please cite the following paper:\n\n * Addi Malviya Thakur, Seth Hitefield, Marshall McDonnell, Matthew Wolf, Richard Archibald, Lance Drane, Kevin Roccapriore, Maxim Ziatdinov, Jesse McGaha, Robert Smith, John Hetrick, Mark Abraham, Sergey Yakubov, Greg Watson, Ben Chance, Clara Nguyen, Matthew Baker, Robert Michael, Elke Arenholz & Ben Mintz. Towards a Software Development Framework for Interconnected Science Ecosystems. In: Doug, K., Al, G., Pophale, S., Liu, H., Parete-Koon, S. (eds) Accelerating Science and Engineering Discoveries Through Integrated Research Infrastructure for Experiment, Big Data, Modeling and Simulation. SMC 2022. Communications in Computer and Information Science, vol 1690. Springer, Cham. https://doi.org/10.1007/978-3-031-23606-8_13\n\nOn GitHub, you can copy this citation in APA or BibTeX format via the \"Cite this repository\" button. Or, see the comments in `CITATION.cff` for the raw BibTeX.\n\n## Acknowledgements\n\nThe INTERSECT-SDK development has received funding support / sponsorship from the following:\n\n * Laboratory Directed Research and Development Program of Oak Ridge National Laboratory, managed by UT-Battelle, LLC, for the U. S. Department of Energy.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Python SDK to interact with INTERSECT",
"version": "0.8.0",
"project_urls": {
"Changelog": "https://github.com/INTERSECT-SDK/python-sdk/blob/main/CHANGELOG.md",
"Documentation": "https://intersect-python-sdk.readthedocs.io/en/latest/",
"Homepage": "https://github.com/INTERSECT-SDK/python-sdk/",
"Issues": "https://github.com/INTERSECT-SDK/python-sdk/issues"
},
"split_keywords": [
"intersect"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "de7822e1c9b8ac0d26a852b06d5b07e3ee78952aab90b0ac7d96d2cf34dbaa00",
"md5": "9804f0509d4e3e47e56db1e0bd3371e2",
"sha256": "f46530da9ae2b0560ad0157eae15e542aed1923704233ee31125790bfff9adf8"
},
"downloads": -1,
"filename": "intersect_sdk-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9804f0509d4e3e47e56db1e0bd3371e2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8.10",
"size": 91047,
"upload_time": "2024-09-11T01:39:28",
"upload_time_iso_8601": "2024-09-11T01:39:28.792247Z",
"url": "https://files.pythonhosted.org/packages/de/78/22e1c9b8ac0d26a852b06d5b07e3ee78952aab90b0ac7d96d2cf34dbaa00/intersect_sdk-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "28c104432b46a37b1cc391ae0796eaee26f15bd18ae989dd329a76b1540ae2c3",
"md5": "d45971bf52d0b7b8570b7cff473c7787",
"sha256": "270a606989244bad3c938e7cd26af2065e6d62a26309b5d5e0590284bc90d03c"
},
"downloads": -1,
"filename": "intersect_sdk-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "d45971bf52d0b7b8570b7cff473c7787",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8.10",
"size": 97758,
"upload_time": "2024-09-11T01:39:30",
"upload_time_iso_8601": "2024-09-11T01:39:30.312716Z",
"url": "https://files.pythonhosted.org/packages/28/c1/04432b46a37b1cc391ae0796eaee26f15bd18ae989dd329a76b1540ae2c3/intersect_sdk-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-11 01:39:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "INTERSECT-SDK",
"github_project": "python-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "intersect-sdk"
}
