Skip to main content

Python SDK to interact with INTERSECT

Project description

Static Badge CI Release to PyPi PyPI version ReadTheDocs

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 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.

For a high-level overview, please see the architecture website.

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, and intends to support multiple different protocols. Currently, we support MQTT 5.0 and AMQP 0.9.1, but other protocols will be supported as well.
    • As a general rule, we will not support any protocols which do not support headers, do not allow for asynchronous messaging, or require the microservice itself to "keep alive" multiple connections.
  • 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.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

intersect_sdk-0.9.3.tar.gz (54.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

intersect_sdk-0.9.3-py3-none-any.whl (66.8 kB view details)

Uploaded Python 3

File details

Details for the file intersect_sdk-0.9.3.tar.gz.

File metadata

  • Download URL: intersect_sdk-0.9.3.tar.gz
  • Upload date:
  • Size: 54.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.23 {"installer":{"name":"uv","version":"0.11.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for intersect_sdk-0.9.3.tar.gz
Algorithm Hash digest
SHA256 b0f563ae161f7851c1281fd4023222ce6509af33fae371f776470d1767dcfb7c
MD5 c57040b07b6f94ee3238ff2793a4a521
BLAKE2b-256 ad4a4197405ffa4d42913d3358cf34d1b0ec15a841c994c5931b3785a975a86a

See more details on using hashes here.

File details

Details for the file intersect_sdk-0.9.3-py3-none-any.whl.

File metadata

  • Download URL: intersect_sdk-0.9.3-py3-none-any.whl
  • Upload date:
  • Size: 66.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.23 {"installer":{"name":"uv","version":"0.11.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for intersect_sdk-0.9.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d02b87b07134de96e060054750cd82445334a573f5df34a451d4d786118c904b
MD5 145c2d88e224c14d92081ee01755f50a
BLAKE2b-256 f053a2fb84ca204d3b794c6c9e93487d38169a075b9422ca27d5b95a794528c2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page