intersect-sdk

Interconnected Science Ecosystem - Software Development Kit (INTERSECT-SDK)

https://github.com/intersect-sdk/python-sdk

Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 4 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.6%) to scientific vocabulary

Keywords

autonomous-experiments event-driven experimental-steering science-ecosystem
Last synced: 6 months ago · JSON representation ·

Repository

Interconnected Science Ecosystem - Software Development Kit (INTERSECT-SDK)

Basic Info
Statistics
  • Stars: 6
  • Watchers: 4
  • Forks: 3
  • Open Issues: 16
  • Releases: 9
Topics
autonomous-experiments event-driven experimental-steering science-ecosystem
Created over 1 year ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Citation

README.md

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

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.

Owner

  • Name: INTERSECT-SDK
  • Login: INTERSECT-SDK
  • Kind: organization

Citation (CITATION.cff)

cff-version: 1.2.0
type: software
message: "If you are referencing INTERSECT-SDK in a publication, please cite it as below."
title: "INTERSECT-SDK: Interconnected Science Ecosystem - Software Development Kit"
authors:
  - family-names: Drane
    given-names: Lance
  - family-names: McDonnell
    given-names: Marshall
  - family-names: Hitefield
    given-names: Seth
  - family-names: Ayres
    given-names: Andrew
  - family-names: Cage
    given-names: Gregory
  - family-names: McGaha
    given-names: Jesse
  - family-names: Smith
    given-names: Robert
  - family-names: Wiggins
    given-names: Gavin
  - family-names: Brim
    given-names: Michael
  - family-names: Archibald
    given-names: Richard
  - family-names: Malviya Thakur
    given-names: Addi
preferred-citation:
  title: "Towards a Software Development Framework for Interconnected Science Ecosystems"
  type: conference-paper
  url: "https://link.springer.com/chapter/10.1007/978-3-031-23606-8_13"
  conference:
    name: "Smoky Mountains Computational Sciences and Engineering Conference 2022"
    city: "Kingsport"
    region: "Tennessee"
    country: "US"
    date-start: 2022-08-23
    date-end: 2022-08-25
  month: 08
  year: 2022
  identifiers:
    - description: "The concept DOI of the work."
      type: doi
      value: 10.1007/978-3-031-23606-8_13
  authors:
    - family-names: Malviya Thakur
      given-names: Addi
      orcid: https://orcid.org/0000-0002-2681-9992
    - family-names: Hitefield
      given-names: Seth
      orcid: https://orcid.org/0000-0003-0331-3128
    - family-names: McDonnell
      given-names: Marshall
      orcid: https://orcid.org/0000-0002-3713-2117
    - family-names: Wolf
      given-names: Matthew
      orcid: https://orcid.org/0000-0002-8393-4436
    - family-names: Archibald
      given-names: Richard
      orcid: https://orcid.org/0000-0002-4538-9780
    - family-names: Drane
      given-names: Lance
      orcid: https://orcid.org/0000-0001-8808-1228
    - family-names: Roccapriore
      given-names: Kevin
      orcid: https://orcid.org/0000-0001-9907-6790
    - family-names: Ziatdinov
      given-names: Maxim
      orcid: https://orcid.org/0000-0003-2570-4592
    - family-names: McGaha
      given-names: Jesse
      orcid: https://orcid.org/0000-0001-9469-8451
    - family-names: Smith
      given-names: Robert
      orcid: https://orcid.org/0000-0002-6058-1025
    - family-names: Hetrick
      given-names: John
      orcid: https://orcid.org/0000-0003-0118-4211
    - family-names: Abraham
      given-names: Mark
    - family-names: Yakubov
      given-names: Sergey
      orcid: https://orcid.org/0000-0002-5829-1280
    - family-names: Watson
      given-names: Gregory
      orcid: https://orcid.org/0000-0002-8591-2441
    - family-names: Chance
      given-names: Ben
    - family-names: Nguyen
      given-names: Clara
    - family-names: Baker
      given-names: Matthew
    - family-names: Michael
      given-names: Robert
    - family-names: Arenholz
      given-names: Elke
      orcid: https://orcid.org/0000-0001-8152-6773
    - family-names: Mintz
      given-names: Ben
      orcid: https://orcid.org/0000-0002-4054-1229

GitHub Events

Total
  • Create event: 7
  • Release event: 3
  • Issues event: 13
  • Watch event: 2
  • Delete event: 3
  • Issue comment event: 13
  • Push event: 21
  • Pull request review comment event: 15
  • Pull request review event: 14
  • Pull request event: 5
  • Fork event: 3
Last Year
  • Create event: 7
  • Release event: 3
  • Issues event: 13
  • Watch event: 2
  • Delete event: 3
  • Issue comment event: 13
  • Push event: 21
  • Pull request review comment event: 15
  • Pull request review event: 14
  • Pull request event: 5
  • Fork event: 3

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 8
  • Total pull requests: 3
  • Average time to close issues: 26 days
  • Average time to close pull requests: 2 days
  • Total issue authors: 1
  • Total pull request authors: 3
  • Average comments per issue: 0.13
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 8
  • Pull requests: 3
  • Average time to close issues: 26 days
  • Average time to close pull requests: 2 days
  • Issue authors: 1
  • Pull request authors: 3
  • Average comments per issue: 0.13
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • Lance-Drane (10)
  • marshallmcdonnell (2)
  • jrmcgaha-dev (1)
Pull Request Authors
  • Lance-Drane (5)
  • marshallmcdonnell (4)
  • jrmcgaha-dev (2)
  • andrewfayres (1)
  • gecage952 (1)
  • yarikoptic (1)
Top Labels
Issue Labels
duplicate (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 118 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 10
  • Total maintainers: 2
pypi.org: intersect-sdk

Python SDK to interact with INTERSECT

  • Versions: 10
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 118 Last month
Rankings
Dependent packages count: 9.4%
Average: 35.7%
Dependent repos count: 61.9%
Maintainers (2)
Last synced: 6 months ago

Dependencies

.github/workflows/publish.yml actions
  • actions/checkout v4 composite
  • pdm-project/setup-pdm v4 composite
  • softprops/action-gh-release v2 composite
.github/workflows/ci.yml actions
  • actions/checkout v4 composite
  • pdm-project/setup-pdm v4 composite
  • bitnami/minio 2024.6.4 docker
  • bitnami/rabbitmq 3.13.3 docker
Dockerfile docker
  • ${REPO}python 3.8-slim build
  • minimal latest build
docker-compose.yml docker
  • bitnami/minio 2024.6.4
  • bitnami/rabbitmq 3.13.3
docs/Dockerfile docker
  • ${IMAGE} ${TAG} build
  • ${NGINX_IMAGE}nginx 1.22-alpine build
pyproject.toml pypi
  • jsonschema [format-nongpl]>=4.21.1
  • minio >=7.2.3
  • paho-mqtt >=1.6.1,<2.0.0
  • pydantic >=2.7.0
  • retrying >=1.3.4,<2.0.0