.. Python SDK documentation master file, created by
   sphinx-quickstart on Mon Apr 24 09:58:36 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

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.

.. toctree::
   :maxdepth: 1
   :caption: Getting started

   installation
   contributing
   core_concepts
   pydantic

.. toctree::
   :maxdepth: 1
   :caption: Examples

   examples/hello-world
   examples/hello-world-events
   examples/counting
   examples/counting-events
   examples/ping-pong-events
   examples/fastapi

.. toctree::
   :maxdepth: 2
   :caption: API documentation

   api/config
   api/core_definitions
   api/schema
   api/capability
   api/service
   api/service_definitions
   api/client
   api/callback_definitions
   api/app_lifecycle
   api/constants
   api/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
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`