quickstart

source/quickstart/01.0_analytics_engine.md

@@ -0,0 +1,17 @@
+# Analytics Engine
+
+The *Cloud Computing Platform (CCP)* is accessible within VLABS via the *Analytics Engine* section.
+
+The *Analytics Engine* section consists of two main pages:
+
+1. The **[Cloud Computing Platform (CCP)](01.2_engine_ccp.md)**: This page allows users to execute predefined methods and monitor their execution.
+
+   ![Cloud Computing Platform](./imgs/analytics_engine_ccp.png)
+
+2. The **[Method/Algorithm Importer](01.3_engine_edit.md)**: This page is used to define new methods, as well as manage and edit existing ones.
+
+   ![Method/Algorithm Importer](./imgs/analytics_engine_importer.png)
+
+---
+
+The pages are composed of a common [method list](01.1_methods_list.md) section on the left, along with specific widgets and forms.

source/quickstart/01.1_methods_list.md

@@ -1,8 +1,6 @@
+# Methods List
 
-
-## Methods List
-
-Both the *Cloud Computing Platform (CCP)* and the *Analytics Engine* displays on the left column the **Methods List** section, which contains all methods available in the current environment. These methods are grouped by category for easy navigation.
+Both the *Cloud Computing Platform (CCP)* and the *Analytics Engine* display the **Methods List** section in the left column, which contains all methods available in the current environment. These methods are grouped by category for easy navigation.
 
 ![Methods List](./imgs/methods_list.png)
 
@@ -11,7 +9,9 @@ Both the *Cloud Computing Platform (CCP)* and the *Analytics Engine* displays on
 ## Method Card
 
 Each method is described by the following attributes:
-- **Name** and **Version Number**: Identifies the method and its version.
+
+- **Name** and **Version Number**: Identifies the method and its version. New versions may indicate updates or improvements, while older versions may be deprecated.
+- **Authors**: The person(s) responsible for creating or maintaining the method.
 - **Description**: Brief explanation of the method’s purpose or functionality.
 - **Tags**: Relevant tags that classify the method.
 - **Infrastructures**: Indicates the infrastructures where the method can be executed (usually, *D4Science Production Infrastructure*).
@@ -22,11 +22,12 @@ Each method is described by the following attributes:
 
 ## Managing Methods
 
-To the right of each method in the list, there is a series of buttons that allow you to execute, edit, or manage the method.
+To the right of each method, a series of buttons allows you to execute, edit, or manage the method.
 
 ![Method Buttons](./imgs/method_buttons.png)
 
 The available actions for each method depend on several factors, including:
+
 - The **current page** you are on (whether you are in the CCP or the Method Importer).
 - The **user’s permissions** regarding the method.
 - The **sharing status** of the method.
@@ -37,34 +38,32 @@ Some buttons may be hidden based on these conditions. Below are the possible act
 
 ### Action Buttons
 
-#### ![Play button](./imgs/method_button_play.png)  **Play Button**  
+#### ![Play button](./imgs/method_button_play.png)  **Play Button**
 
 Loads the method into the execution form, where users can configure the input and start the execution.
 
 > **Availability**: Shown only on the *Cloud Computing Platform (CCP)* page. The method must have at least one available infrastructure in the current VRE (Virtual Research Environment) to be executed; otherwise, the button will be hidden.
 
-#### ![Edit button](./imgs/method_button_edit.png)  **Edit Button**  
+#### ![Edit button](./imgs/method_button_edit.png)  **Edit Button**
 
 Loads the method into the editing form, where users can manage and modify the method’s definition.
 
 > **Availability**: Shown only on the *Method/Algorithm Importer* page.
 
-#### ![Download button](./imgs/method_button_download.png)  **Download Button**  
+#### ![Download button](./imgs/method_button_download.png)  **Download Button**
 
 Downloads the JSON file that defines the method.
 
-#### ![Archive button](./imgs/method_button_archive.png) **Archive Button**  
+#### ![Archive button](./imgs/method_button_archive.png) **Archive Button**
 
-Similar to the download button, but saves the method’s JSON file to the user’s workspace instead of downloading it to the local machine.
+Similar to the download button, but saves the method’s JSON file to the user’s workspace instead of downloading it to the local machine
 
-#### ![Share button](./imgs/method_button_share.png) **Share Button**  
+#### ![Share button](./imgs/method_button_share.png) **Share Button**
 
 Clicking this button shares the method with others in the environment.
 
-> **Availability**: Appears only for methods defined by the user that have not yet been shared with the community.
+> **Availability**: Appears only for methods defined by the user that have not yet been shared with the community. Once shared, the method becomes visible to users across the relevant VREs, depending on the permissions set by the original creator.
 
-#### ![Archived label](./imgs/method_button_shared.png) **Archived Label**  
+#### ![Archived label](./imgs/method_button_shared.png) **Archived Label**
 
 Indicates that the method has been shared with the community.
-
-

source/quickstart/01.2_engine_ccp.md

@@ -0,0 +1,61 @@
+# Cloud Computing Platform (CCP) Page
+
+The **Cloud Computing Platform** page allows users to execute predefined methods and monitor their execution.
+
+The page is composed of:
+
+* The **Methods List** section on the left, displaying the list of all available methods (see [Methods List](./07_methods_list.md)).
+* The **Method Execution form** section, used to configure and start the execution of an available method.
+* The **Execution Monitor** section, used to monitor scheduled, pending, and finished executions.
+
+![Cloud Computing Platform (CCP)](./imgs/analytics_engine_ccp.png)
+---
+
+## **Method Execution form** Section
+
+In the **Method Execution** section, users can configure the input parameters required for the execution of a selected method. Depending on the method selected, users may need to provide input files, set runtime options, and choose execution parameters.
+
+The inputs required can include:
+
+- **Runtime**: Specifies the environment in which the method will run. This may vary depending on the selected method.
+- **Annotations**: Parameters or tags that may be required or associated with the execution.
+- **Input files or URLs**: Paths to files or URLs that are used as input for the method being executed.
+
+### **Options**
+
+Users can choose to automatically archive the execution provenance when the process completes or customize additional execution parameters depending on their needs.
+
+### **Outputs**
+
+This section displays the results generated by the method execution. These outputs may include processed images, data files, or logs, depending on the method being used.
+
+Finally, by clicking the **Execute** button, the method will be executed with the specified configuration, and users can track its progress and status in the **Monitor** section on the right side of the page.
+
+## **Execution Monitor** Section
+
+The **Execution Monitor** section, located on the right side of the page, allows users to track the progress of their method executions. It is divided into two main tabs:
+
+- **Live Executions**: Displays the currently running or recently executed methods.
+- **Archived Executions**: Shows the history of previously completed executions.
+
+### **Live Executions**
+
+In the **Live Executions** tab, users can see the status of methods that are currently in progress or have just finished. Each execution is accompanied by important information, such as:
+
+- **Method Name** and **Version**: Identifies the method being executed.
+- **Status**: Indicates the current state of the execution (e.g., pending, running, successful, failed).
+- **Timestamp**: Shows when the execution was accepted and the last update received.
+
+Additionally, users can:
+
+- **Re-submit**: Restart the execution of a previously run method by clicking the "Re-submit" button.
+
+### **Archived Executions**
+
+The **Archived Executions** tab stores the history of all past executions. Each record contains the following details:
+
+- **Execution Name**: The name of the method that was executed.
+- **Status**: Final result of the execution (e.g., successful, failed).
+- **Details**: Information about the inputs, outputs, and logs related to the execution.
+
+Users can review archived executions to analyze performance, troubleshoot errors, or re-run methods if needed. All output files and logs are accessible for download or further analysis.

source/quickstart/01.3_engine_edit.md

@@ -0,0 +1,2 @@
+# Method/Algorithm Importer
+

source/quickstart/05_analytics_engine.md

@@ -1,16 +0,0 @@
-# Analytics Engine
-
-The *Cloud Computing Platform (CCP)* is accessible within the VLABS via the *Analytics Engine* section.
-
-The *Analytics Engine* section consists of two main pages:
-1. The **Cloud Computing Platform (CCP)**: This page allows users to execute defined methods and to monitor their execution.
-
-![Cloud Computing Platform](./imgs/analytics_engine_ccp.png)
-
-
-2. The **Method/Algorithm Importer**: This page is used to define new methods, as well as manage and edit existing ones.
-
-![Method/Algorithm Importer](./imgs/analytics_engine_importer.png.png)
-
-
----

source/quickstart/10_method_json.md

@@ -1,3 +1 @@
-# Analytics Engine
-
-The *Analytics Engine* section is composed by 2 pages, the *Cloud Computing Platform (CCP)*, 
+# Methods Json

source/quickstart/21_basic_python.md

@@ -1,4 +1,4 @@
-### standard preconfigured images Python or R images
+### Running a Python implementation
 
 Python methods can be implemented compiling the *ccpimage* field with a standard python docker image (es `python:3.9.19`)
 
@@ -8,7 +8,7 @@ We can then define an input `repository` field
 
 ![input repository](./imgs/input_repository.png)
 
-and configure the  *deploy script* to git clone the repository , using the placeholder `{{repository}}` to refer the input repository field
+and configure the  *deploy script* to git clone the repository and install the dependencies, using the placeholder `{{repository}}` to refer the input repository field
 
 ```sh
 git clone {{repository}}

source/quickstart/index.rst

@@ -1,4 +1,4 @@
-Use Cases
+Quickstart
 =========
 
 .. toctree::