.. iDDS documentation master file, created by
   sphinx-quickstart on Mon Apr 20 15:55:26 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to iDDS's documentation!
================================

iDDS(intelligent Data Delivery Service) is an intelligent Data Delivery Service. It's designed
to intelligently transform and deliver the needed data to the processing workflow in a
fine-grained approach for High Energy Physics workloads.

iDDS is developed with modular and is highly scalable with a serializable Work/Workflow structure.

This documentation is generated by the `Sphinx toolkit`_. and lives in the `source tree`_.

.. _`Sphinx toolkit`: http://sphinx.pocoo.org/
.. _`source tree`: https://github.com/HSF/iDDS/tree/master/docs/source

General Information
===================

This section contains the general information related to iDDS which is common to
all developers, users, and operators.
For documentation specific to any of these three, please see the subsequent sections.

.. toctree::
   :maxdepth: 1

   general/v2/requirements_functions
   general/v2/schematic_view
   general/v2/architecture
   general/v2/workflow
   general/v2/dag
   general/v2/authorization

Use Cases
=========

Here it includes use cases that iDDS supports or will supports.

.. toctree::
   :maxdepth: 1

   usecases/data_carousel
   usecases/active_learning
   usecases/hyperparemeter_optimization
   usecases/doma_rubin

User Documentation
==================

.. toctree::
   :maxdepth: 1

   users/installing_client
   users/cli_examples
   users/condition_examples
   users/workflow_examples
   users/monitorapi_examples
   users/admin_guides
   users/contributing

DOMA User Documentation
=========================

.. toctree::
      :maxdepth: 1

   domausers/installing_client
   domausers/cli_examples

Source Codes
=============

.. toctree::
   :maxdepth: 1

   source_codes

Indices and tables
==================

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