Difference between revisions of "Statistical Algorithms Importer"

From Gcube Wiki
Jump to: navigation, search
(Main Topics)
 
(26 intermediate revisions by 3 users not shown)
Line 3: Line 3:
 
|}
 
|}
  
This is the user guide to Statistical Algorithms Importer portlet.
+
In this guide we describe the Statistical Algorithms Importer (also known as '''Methods Importer''' or  '''Software Algorithms Importer''') web interface.
  
 
== Overview ==
 
== Overview ==
Statistical Algorithms Importer (SAI) is a tool to import algorithms in infrastructure.
+
This Methods Importer (SAI) is a tool to import algorithms in the D4Science e-Infrastructure. Currently, it supports different types of software integration. SAI separates software development from its deployment in the infrastructure in a very flexible way. After the first deployment, made in collaboration with the e-Infrastructure team, script developers can modify and update their scripts by themselves, without the intervention of the e-Infrastructure team.
  
 +
In order to transform an algorithm, three main passages are required:
  
[[Image:StatisticalAlgorithmsImporter1.png|thumb|center|800px|Statistical Algorithms Importer (SAI), portlet]]
+
1 - Indicate Input, Output and types of a main script orchestrating the process
  
== Main Topics==
+
2 - Create the Software: this operation creates the interface from the e-Infrastructure service to the script and should be used each time either the interface (I/O) or the name of the algorithm or the required additional packages change
* [[Statistical Algorithms Importer: Create Project|Create Project]]
+
* [[Statistical Algorithms Importer: Create Software|Create Software]]
+
* [[Statistical Algorithms Importer: Publish Algorithms| Publish Algorithms]]
+
* [[Statistical Algorithms Importer: Repackage| Repackage]]
+
  
 +
3 - Publish the Software: this operation communicates to the infrastructure that a newly create software should be put online
  
<!--
+
Additionally, the Repackage function can be used when only the internal code of the orchestrating script changes and the algorithms has already been published.
==References==
+
The pages in this Wiki explain the details of these operations.
{{Reflist}} -->
+
  
 +
[[Image:StatisticalAlgorithmsImporter1.png|thumb|center|800px|Statistical Algorithms Importer (SAI), portlet. Main interface.]]
 +
 +
== F.A.Q. ==
 +
Please, read our best practices first: [[Statistical Algorithms Importer: FAQ|F.A.Q.]]
 +
 +
== Demonstration ==
 +
A demonstration video is available [http://data.d4science.org/SkhVR3AyTUNLaStCV2tNdUhsL2VIQ3AwMG1tTjVka3dHbWJQNStIS0N6Yz0 here].
 +
 +
== Main Steps==
 +
 +
# [[Statistical Algorithms Importer: Create Project|Creating a new Project]]
 +
# [[Statistical Algorithms Importer: Publish Algorithms|Publishing Algorithms for deployment]]
 +
# [[Statistical Algorithms Importer: Repackage| Repackaging a script]]
 +
# [[Advanced Input| Advanced Input ]]
 +
# [[Statistical Algorithms Importer: StatusUpdate| Updating the status of a computation]]
 +
# [[Statistical Algorithms Importer: FAQ|F.A.Q.]]
 +
# [[Statistical_Algorithms_Importer:_R_Project#Import_Resources_From_GitHub | Import projects from GitHub ]]
 +
 +
==Related Links==
 +
* [[DataMiner_Manager|DataMiner Manager]]
  
 
<!--
 
<!--
 +
==References==
 +
{{Reflist}}
 
[[Template:Statistical Algorithms Importer]]  
 
[[Template:Statistical Algorithms Importer]]  
 
-->
 
-->
  
 
[[Category:Statistical Algorithms Importer]]
 
[[Category:Statistical Algorithms Importer]]
 +
[[Category:DataMiner]]
 +
[[Category:User's Guide]]

Latest revision as of 09:05, 15 April 2020

In this guide we describe the Statistical Algorithms Importer (also known as Methods Importer or Software Algorithms Importer) web interface.

Overview

This Methods Importer (SAI) is a tool to import algorithms in the D4Science e-Infrastructure. Currently, it supports different types of software integration. SAI separates software development from its deployment in the infrastructure in a very flexible way. After the first deployment, made in collaboration with the e-Infrastructure team, script developers can modify and update their scripts by themselves, without the intervention of the e-Infrastructure team.

In order to transform an algorithm, three main passages are required:

1 - Indicate Input, Output and types of a main script orchestrating the process

2 - Create the Software: this operation creates the interface from the e-Infrastructure service to the script and should be used each time either the interface (I/O) or the name of the algorithm or the required additional packages change

3 - Publish the Software: this operation communicates to the infrastructure that a newly create software should be put online

Additionally, the Repackage function can be used when only the internal code of the orchestrating script changes and the algorithms has already been published. The pages in this Wiki explain the details of these operations.

Statistical Algorithms Importer (SAI), portlet. Main interface.

F.A.Q.

Please, read our best practices first: F.A.Q.

Demonstration

A demonstration video is available here.

Main Steps

  1. Creating a new Project
  2. Publishing Algorithms for deployment
  3. Repackaging a script
  4. Advanced Input
  5. Updating the status of a computation
  6. F.A.Q.
  7. Import projects from GitHub

Related Links