Workflow and code repositories usually require small amounts of storage space and it is envisaged that after quality control, researchers should be provided with the appropriate storage to store their datasets for them to be accessible and freely available for other researchers to access without any form of restrictions. Workflow, pipeline and software repository tools should be added to the VRE portal through the following guidelines.
- Accompanying documentation: In case of code, README.md files must be provided with instructions on how to access, compile and/or use it.
- Training material: The training material will cover scientific aspects of the application, and must be hosted on the VI-SEEM training portal.
Existing workflows and code can be found at the following pages:
Scientific workflows/pipelines can come in various forms:
- scripts that automate data generation and processing,
- interfaces that ease the use of tools and software applications and
- documents that describe scientific processes and/or training material in various formats (e.g., pdf, doc, ppt).
Depending on the workflow type (code or documents), files are submitted as follows:
- Scripts/Code: on the code repository (see also Contributing Code below)
- Documents: on the VI-SEEM repository following the guidelines for uploading datasets
These steps should be followed when uploading code to the VRE portal:
- Upload your software to the VI-SEEM code repository
- Create a repository for each project
- Create a README.md file that describes the project and how to compile and run
- Upload training material regarding the code in the “Training portal”
- A description of the application
- Responsible scientist details
- Links to documentation material
- Links to training material