... | @@ -8,20 +8,36 @@ Virtual Research Environments integrate tools and pipelines to enforce a researc |
... | @@ -8,20 +8,36 @@ Virtual Research Environments integrate tools and pipelines to enforce a researc |
|
### Why?
|
|
### Why?
|
|
open Virtual Research Environment offers a number of benefits for developers willing to integrate their tools in the platform:
|
|
open Virtual Research Environment offers a number of benefits for developers willing to integrate their tools in the platform:
|
|
|
|
|
|
- Open access service publicly available
|
|
- Open access platform publicly available
|
|
- A user-friendly web interface with user support utilities, authentication service and data handlers for local and remote datasets and repositories.
|
|
- A full web-based workbench with user support utilities, OIDC authentication service, and data handlers for local and remote datasets or repositories.
|
|
- Visibility for your tool and organization, with ownership recognition, tailored web forms, help pages and customized viewers
|
|
- Visibility for your tool and organization, with ownership recognition, tailored web forms, help pages and customized viewers.
|
|
- The possibility to add extra value to your tool by complementing it with other related tools already in the platform.
|
|
- The possibility to add extra value to your tool by complementing it with other related tools already in the platform.
|
|
- A complete administration panel for monitoring, logging and managing your tool.
|
|
- A complete control of your tool through the administration panel, for monitoring, logging and managing your tool.
|
|
|
|
|
|
#### Requirements
|
|
#### Requirements
|
|
The application or pipeline to be integrated should be
|
|
The application or pipeline to be integrated should:
|
|
- free and open source code
|
|
- Be free and open source code
|
|
- Run in non-interactively mode in linux-based virtual machines.
|
|
- Run in non-interactively mode in linux-based operating system:
|
|
|
|
- Ubuntu 18.04
|
|
### How it works?
|
|
- Ubuntu 20.04
|
|
|
|
- CentOS 8 Stream
|
|
|
|
- *consult with us for others O.S*
|
|
|
|
|
|
|
|
|
|
|
|
### How it works?
|
|
|
|
|
|
|
|
There are some steps to follow for achieving the integration of a your application as a new VRE tool. As a result, the VRE is able to control the whole tool execution cycle:
|
|
|
|
1. Prepare the run web form where the user will specify arguments and inputs files for each run.
|
|
|
|
2. Validate input files and arguments requirements
|
|
|
|
3. Stage in input files to the run working directory (if required)
|
|
|
|
4. Execute the tool in the cloud in a scalable manner
|
|
|
|
5. Monitor and interactively report tool progress during the execution
|
|
|
|
6. Stage out output files from the run working directory (if required)
|
|
|
|
7. Register at the VRE the resulting output files to display them at the VRE
|
|
|
|
|
|
### How to?
|
|
### How to?
|
|
|
|
Essentially, VRE will need twoTool developers should follow four basic steps that provides MuGVRE with the sufficient information to accomplish the whole tool execution cycle, explained in detail at Bring your tool → Integration of tools . Once these steps are completed, MuGVRE will be able to:
|
|
|
|
|
|
Step 1 - Define your tool's input and output files. The information is used to build job execution files for testing the RUNNER.
|
|
Step 1 - Define your tool's input and output files. The information is used to build job execution files for testing the RUNNER.
|
|
|
|
|
|
Step 2 - Prepare a new VRE RUNNER wrapping your application.
|
|
Step 2 - Prepare a new VRE RUNNER wrapping your application.
|
... | | ... | |