feat: add documentation about ComputingElement

DIRACGrid · May 8, 2023 · 571772e · 571772e
1 parent f3e4b4d
commit 571772e
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/docs/source/DeveloperGuide/AddingNewComponents/Resources/Computing.rst b/docs/source/DeveloperGuide/AddingNewComponents/Resources/Computing.rst
@@ -0,0 +1,5 @@
+----------------
+ComputingElement
+----------------
+
+The full code documentation is available here :py:class:`~DIRAC.Resources.Computing.ComputingElement`
diff --git a/docs/source/DeveloperGuide/AddingNewComponents/Resources/index.rst b/docs/source/DeveloperGuide/AddingNewComponents/Resources/index.rst
@@ -16,5 +16,6 @@ DIRAC applications
    :maxdepth: 2
 
    Catalog
+   Computing
    MessageQueues/index
    Storage
diff --git a/src/DIRAC/Resources/Computing/ComputingElement.py b/src/DIRAC/Resources/Computing/ComputingElement.py
@@ -19,6 +19,17 @@
 
      The ComputingElement objects are usually instantiated with the help of
      ComputingElementFactory.
+
+     The ComputingElement class can be considered abstract. 3 kinds of abstract ComputingElements
+     can be distinguished from it:
+
+      - Remote ComputingElement: includes methods to interact with a remote ComputingElement
+        (e.g. HtCondorCEComputingElement, ARCComputingElement).
+      - Inner ComputingElement: includes methods to locally interact with an underlying worker node.
+        It is worth noting that an Inner ComputingElement provides synchronous submission
+        (the submission of a job is blocking the execution until its completion). It deals with one job at a time.
+      - Inner Pool ComputingElement: includes methods to locally interact with Inner ComputingElements asynchronously.
+        It can manage a pool of jobs running simultaneously.
 """
 
 import os