Batch Run Feature Development

docs/other/index.rst

@@ -8,4 +8,5 @@ Other
 
   host_for_multiuser/index
   cli_execution
+  workflow_batch_run
   debugging

docs/other/workflow_batch_run.md

@@ -0,0 +1,124 @@
+(workflow-batch-run)=
+Workflow Batch Run
+=================
+
+By using the Workflow Batch Run function, you can batch-execute workflows set of input data.
+
+\*This feature is limited to ["Multi User Mode"](host_for_multiuser/index.rst).
+
+```{contents}
+:depth: 3
+```
+
+## Usage Procedure
+
+### Creating a Workspace (Batch Type)
+
+<p>
+<img src="../_static/workflow_batch_run/batch_workspaces.png" alt="Workspaces" />
+</p>
+
+- Specify the type of workspace as Batch when creating a Workspace.
+
+### Batch Workspace specifics
+
+Batch workspaces have the following UI changes:
+
+<p>
+<img src="../_static/workflow_batch_run/batch_workflow_1.png" alt="Workflow" />
+</p>
+
+- (1) Display Type: Batch
+- (2) From the Batch Data section in the left side menu, you can select each Batch Input Node.
+- (3) The "Run" button will display as the "Batch Run" button.
+
+### Selecting Data
+
+<p>
+<img src="../_static/workflow_batch_run/batch_workflow_2.png" alt="Workflow" />
+</p>
+
+- (1) Batch Input Nodes
+  - Place a Batch Input Node from "Batch Data" in the left side menu.
+    - As an example, batch_image and batch_behavior are placed here.
+  - Each Batch Input Node corresponds to a standard Input Node.
+    - `batch_{image, csv, fluo, behavior, microscope, hdf5, matlab}`
+- (2) File Select dialog
+  - Each Batch Input Node can select multiple files.
+
+```{eval-rst}
+.. note::
+    * **Data set handling**
+        * Data are processed in the order they are selected.
+            * All input data are matched based on their order, whereby image and behaviour in position 1 will be processed together, followed by all of the data in position 2, and so on.
+            * Data in each node can be easily reordered by dragging up or down in the data list of that node.
+    * **Validation rule**
+        * Verify that the number of data in each Batch Input Data Node matches.
+            * Only the number of data items is checked. File names and data contents are not checked.
+```
+
+### Setting dialogs
+
+<p>
+<img src="../_static/workflow_batch_run/batch_workflow_3.png" alt="Workflow" />
+</p>
+
+- (1) CSV Setting dialog
+  - For CSV-based Nodes (`batch_{cvs, fluo, behavior}`), various settings can be made in the CSV Setting dialog.
+  - In the CSV Setting dialog, **the contents of the first file** is previewed, and **same settings are applied to all files**.
+- (2) Select Structure dialog
+  - For Structured data type Nodes (`batch_{hdf5, matlab}`), the path of Input Data can be selected in the Select Structure dialog.
+  - In the Select Structure dialog, **the contents of the first file (Structure)** is displayed, and **same settings are applied to all files**.
+- (3) Node Param Setting
+  - The parameter settings for each node apply **the same settings to all workflows**.
+
+```{eval-rst}
+.. note::
+    * All workflows will complete with the **same parameter configuration**.
+```
+
+### Batch Run
+
+<p>
+<img src="../_static/workflow_batch_run/batch_button.png" alt="Batch Run Button" />
+</p>
+
+#### Batch Run Button execution behavior
+
+- Validation for Input Data
+  - Check the number of items for each Batch Input Data
+    - \***The only check condition is the number of items.** File names and data contents are not checked.
+- Execute Batch Run
+  - No reservations, immediate execution only
+    - As soon as the process is successfully started, the Workflow will immediately have a completed status.
+  - The following records are generated
+    - Batch Workflow Template
+      - Generate one Template Workflow as the basis of Running Workflow .
+    - Batch Workflow
+      - Automatically create Workflows for the number of Data items based on Batch Workflow Template and start parallel execution.
+
+```{eval-rst}
+..  note::
+    * About workflow behavior after RUN BATCH
+        * When submitting a RUN BATCH command, "the template workflow" then submits a new workflow (job) for each set of data.
+        * The template workflow will be shown as successful if this job submission itself is successful. However, this does **not** mean any of the jobs themselves have been completed successfully.
+        * The progress of each job can be seen in the RECORDS tab. Note that individual workflows run independently and some may still succeed or fail depending on the data contents and parameters selected.
+```
+
+## Record Screen
+
+<p>
+<img src="../_static/workflow_batch_run/batch_record.png" alt="Record" />
+</p>
+
+- (1) Record of Batch Workflow Template
+  - Created when Batch Run Button is executed.
+  - This Workflow does not run snakemake directly.
+- (2) Record of Batch Workflow
+  - Records of each workflow actually executed based on Batch Workflow Template
+  - Same content as regular Workflow Record
+  - "Name" is automatically generated based on the Template Name
+- (3) Other menu of Batch Workflow Template
+  - Reproduce ... Batch Workflow Template can be reproduced
+  - Download workflow yaml ... You can also download and import Batch Workflow Template workflow.yaml
+  - Download snakemake yaml ... It is not possible to download snakemake.yaml of Batch Workflow Template (because it is not subject to snakemake execution)

frontend/src/api/run/Run.ts

@@ -81,6 +81,17 @@ export async function runByUidApi(
   return response.data
 }
 
+export async function batchRunApi(
+  workspaceId: number,
+  data: RunPostData,
+): Promise<string> {
+  const response = await axios.post(
+    `${BASE_URL}/run/util/batch_run/${workspaceId}`,
+    data,
+  )
+  return response.data
+}
+
 export type RunResultDTO = {
   [nodeId: string]: {
     status: string

frontend/src/api/workspace/index.ts

@@ -1,13 +1,18 @@
 import { stringify } from "qs"
 
+import { WORKSPACE_TYPE } from "const/Workspace"
 import {
   ItemsWorkspace,
   WorkspaceDataDTO,
   ListUserShareWorkspaceDTO,
 } from "store/slice/Workspace/WorkspaceType"
 import axios from "utils/axios"
 
-export type WorkspacePostDataDTO = { name: string; id?: number }
+export type WorkspacePostDataDTO = {
+  id?: number
+  name: string
+  type: WORKSPACE_TYPE
+}
 
 export const getWorkspaceApi = async (id: number): Promise<ItemsWorkspace> => {
   const response = await axios.get(`/workspace/${id}`)

frontend/src/components/Workspace/FlowChart/Buttons/CreateWorkflow.tsx

@@ -5,15 +5,17 @@ import { AddToPhotos } from "@mui/icons-material"
 import { IconButton, Tooltip } from "@mui/material"
 
 import { ConfirmDialog } from "components/common/ConfirmDialog"
-import { WORKSPACE_TYPE } from "const/Workspace"
 import { clearFlowElements } from "store/slice/FlowElement/FlowElementSlice"
 import { selectPipelineIsStartedSuccess } from "store/slice/Pipeline/PipelineSelectors"
+import { RootState } from "store/store"
 
 export const CreateWorkflowButton = memo(function CreateWorkflowButton() {
   const [open, setOpen] = useState(false)
   const dispatch = useDispatch()
   const isPending = useSelector(selectPipelineIsStartedSuccess)
-  const workspaceType = WORKSPACE_TYPE.DEFAULT // Currently a fixed value
+  const workspaceType = useSelector(
+    (state: RootState) => state.workspace.currentWorkspace.type,
+  )
 
   const openDialog = () => {
     setOpen(true)