Merge pull request #95 from ICRAR/LIU-213-doxygen

LIU-213 add data drop doxygen definitions

daliuge-engine/dlg/drop.py

@@ -1160,6 +1160,22 @@ def path(self):
         return self._path
 
 
+##
+# @brief File
+# @details A standard file on a filesystem mounted to the deployment machine
+# @par EAGLE_START
+# @par category File
+# @param[in] param/data_volume Data volume/5/Float/readwrite/
+#     \~English Estimated size of the data contained in this node
+# @param[in] param/group_end Group end/False/Boolean/readwrite/
+#     \~English Is this node the end of a group?
+# @param[in] param/check_filepath_exists Check file path exists/True/Boolean/readwrite/
+#     \~English Perform a check to make sure the file path exists before proceeding with the application
+# @param[in] param/filepath File Path//String/readwrite/
+#     \~English Path to the file for this node
+# @param[in] param/dirname Directory name//String/readwrite/
+#     \~English Path to the file for this node
+# @par EAGLE_END
 class FileDROP(AbstractDROP, PathBasedDrop):
     """
     A DROP that points to data stored in a mounted filesystem.
@@ -1320,6 +1336,28 @@ def dataURL(self):
         return "file://" + hostname + self._path
 
 
+##
+# @brief NGAS
+# @details An archive on the Next Generation Archive System (NGAS).
+# @par EAGLE_START
+# @par category File
+# @param[in] param/data_volume Data volume/5/Float/readwrite/
+#     \~English Estimated size of the data contained in this node
+# @param[in] param/group_end Group end/False/Boolean/readwrite/
+#     \~English Is this node the end of a group?
+# @param[in] param/ngsSrv NGAS Server/localhost/String/readwrite/
+#     \~English The URL of the NGAS Server
+# @param[in] param/ngasPort NGAS Port/7777/Integer/readwrite/
+#     \~English The port of the NGAS Server
+# @param[in] param/ngasFileId File ID//String/readwrite/
+#     \~English File ID on NGAS (for retrieval only)
+# @param[in] param/ngasConnectTimeout Connection timeout/2/Integer/readwrite/
+#     \~English Timeout for connecting to the NGAS server
+# @param[in] param/ngasMime NGAS mime-type/text\/ascii/String/readwrite/
+#     \~English Mime-type to be used for archiving
+# @param[in] param/ngasTimeout NGAS timeout/2/Integer/readwrite/
+#     \~English Timeout for receiving responses for NGAS
+# @par EAGLE_END
 class NgasDROP(AbstractDROP):
     """
     A DROP that points to data stored in an NGAS server
@@ -1418,6 +1456,16 @@ def dataURL(self):
         return "ngas://%s:%d/%s" % (self.ngasSrv, self.ngasPort, self.fileId)
 
 
+##
+# @brief Memory
+# @details In-memory storage of intermediate data products
+# @par EAGLE_START
+# @par category Memory
+# @param[in] param/data_volume Data volume/5/Float/readwrite/
+#     \~English Estimated size of the data contained in this node
+# @param[in] param/group_end Group end/False/Boolean/readwrite/
+#     \~English Is this node the end of a group?
+# @par EAGLE_END
 class InMemoryDROP(AbstractDROP):
     """
     A DROP that points data stored in memory.
@@ -2078,13 +2126,29 @@ def execute(self, _send_notifications=True):
         self._notifyAppIsFinished()
 
 
+##
+# @brief Plasma
+# @details An object in a Apache Arrow Plasma in-memory object store
+# @par EAGLE_START
+# @par category Plasma
+# @param[in] param/data_volume Data volume/5/Float/readwrite/
+#     \~English Estimated size of the data contained in this node
+# @param[in] param/group_end Group end/False/Boolean/readwrite/
+#     \~English Is this node the end of a group?
+# @param[in] param/plasma_path Plasma Path//String/readwrite/
+#     \~English Path to the local plasma store
+# @param[in] param/object_id Object Id//String/readwrite/
+#     \~English PlasmaId of the object for all compute nodes
+# @param[in] param/use_staging Use Staging/False/Boolean/readwrite/
+#     \~English Enables writing to a dynamically resizeable staging buffer
+# @par EAGLE_END
 class PlasmaDROP(AbstractDROP):
     """
     A DROP that points to data stored in a Plasma Store
     """
 
-    object_id = dlg_string_param("object_id", None)
     plasma_path = dlg_string_param("plasma_path", "/tmp/plasma")
+    object_id = dlg_string_param("object_id", None)
     use_staging = dlg_bool_param("use_staging", False)
 
     def initialize(self, **kwargs):
@@ -2105,6 +2169,23 @@ def dataURL(self):
         return "plasma://%s" % (binascii.hexlify(self.object_id).decode("ascii"))
 
 
+##
+# @brief PlasmaFlight
+# @details An Apache Arrow Flight server providing distributed access
+# to a Plasma in-memory object store
+# @par EAGLE_START
+# @par category Plasma
+# @param[in] param/data_volume Data volume/5/Float/readwrite/
+#     \~English Estimated size of the data contained in this node
+# @param[in] param/group_end Group end/False/Boolean/readwrite/
+#     \~English Is this node the end of a group?
+# @param[in] param/plasma_path Plasma Path//String/readwrite/
+#     \~English Path to the local plasma store
+# @param[in] param/object_id Object Id//String/readwrite/
+#     \~English PlasmaId of the object for all compute nodes
+# @param[in] param/flight_path Flight Path//String/readwrite/
+#     \~English IP and flight port of the drop owner
+# @par EAGLE_END
 class PlasmaFlightDROP(AbstractDROP):
     """
     A DROP that points to data stored in a Plasma Store

daliuge-engine/dlg/s3_drop.py

@@ -30,6 +30,22 @@
 from .meta import dlg_string_param, dlg_list_param
 
 
+##
+# @brief S3
+# @details A 'bucket' object available on Amazon's Simple Storage Service (S3)
+# @par EAGLE_START
+# @par category S3
+# @param[in] param/data_volume Data volume/5/Float/readwrite/
+#     \~English Estimated size of the data contained in this node
+# @param[in] param/group_end Group end/False/Boolean/readwrite/
+#     \~English Is this node the end of a group?
+# @param[in] param/bucket Bucket//String/readwrite/
+#     \~English The S3 Bucket
+# @param[in] param/object_name Object Name//String/readwrite/
+#     \~English The S3 Object
+# @param[in] param/profile_name Profile Name//String/readwrite/
+#     \~English The S3 Profile
+# @par EAGLE_END
 class S3DROP(AbstractDROP):
     """
     A DROP that points to data stored in S3