Python SDK for INTERSECT

This site provides documentation for INTERSECT’s Python SDK. See the getting started section for installation and usage instructions as well as guidelines for contributing to the project. Examples of using the SDK are discussed in the examples section. See the API documentation for more information about the SDK components.

Getting started

• Installation and usage
• Contributing
• Core Concepts
• Pydantic

Examples

• Hello world
• Hello world With events
• Counting
• Counting With Events
• Ping Pong Events
• Integrating with FastAPI

API documentation

• Config
  • Config - Shared
  • Config - Service
  • Config - Client
• Core Definitions
  • IntersectDataHandler
  • IntersectMimeType
• Schema
  • get_schema_from_capability_implementations()
• Capability
• Service
  • IntersectService
• Service Definitions
  • IntersectEventDefinition
  • intersect_message()
  • intersect_status()
• Client
  • IntersectClient
• Callback Definitions
  • Shared
  • Client
  • Service
• Application Lifecycle
  • SignalHandler
  • default_intersect_lifecycle_loop()
• Constants
  • CAPABILITY_REGEX
  • MIME_TYPE_REGEX
  • SYSTEM_OF_SYSTEM_REGEX
• Version

Contact

For questions about the overall INTERSECT project, please contact Ben Mintz. For questions regarding the usage and development of the INTERSECT SDK, please contact Addi Malviya-Thakur, Rich Archibald, Seth Hitefield, Marshall McDonnell, or Lance Drane using the email address given below.

Email: intersect-sdk-devs@ornl.gov

Citations

Thakur, A.M. et al. (2022). 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

Indices and tables

• Index

• Module Index

• Search Page