Skip to content

Commit c5df5f4

Browse files
committed
feat: add documentation about ComputingElement
1 parent 6465d5e commit c5df5f4

File tree

3 files changed

+17
-0
lines changed

3 files changed

+17
-0
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
----------------
2+
ComputingElement
3+
----------------
4+
5+
The full code documentation is available here :py:class:`~DIRAC.Resources.Computing.ComputingElement`

docs/source/DeveloperGuide/AddingNewComponents/Resources/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,6 @@ DIRAC applications
1616
:maxdepth: 2
1717

1818
Catalog
19+
Computing
1920
MessageQueues/index
2021
Storage

src/DIRAC/Resources/Computing/ComputingElement.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,17 @@
1919
2020
The ComputingElement objects are usually instantiated with the help of
2121
ComputingElementFactory.
22+
23+
The ComputingElement class can be considered abstract. 3 kinds of abstract ComputingElements
24+
can be distinguished from it:
25+
26+
- Remote ComputingElement: includes methods to interact with a remote ComputingElement
27+
(e.g. HtCondorCEComputingElement, ARCComputingElement).
28+
- Inner ComputingElement: includes methods to locally interact with an underlying worker node.
29+
It is worth noting that an Inner ComputingElement provides synchronous submission
30+
(the submission of a job is blocking the execution until its completion). It deals with one job at a time.
31+
- Inner Pool ComputingElement: includes methods to locally interact with Inner ComputingElements asynchronously.
32+
It can manage a pool of jobs running simultaneously.
2233
"""
2334

2435
import os

0 commit comments

Comments
 (0)