USE CASE TEMPLATE #20
Description
This is a template to structure the integration of the use cases' analyses into AquaINFRA's virtual research environment.
Please copy this template and assign all those who should be involved using the "Assignees" - feature on the right, for example, any developers or use case members from your side.
And please use the comment section below. No mailing will be necessary and the entire communication is in one place. Individual persons can be pinged using, for instance, @MarkusKonk
Description
- Rather a technical than a thematic description
- How to run the analysis?
- Which programming languages are used?
- How does the workflow look like?
- Which functions are used and how are they connected?
- Anything else needed to run the analysis?
URLs
URL to input datasets:
URL to GitHub:
Commands for running R/Python scripts
Commands for running Docker commands:
cURL Commands for running OGC API Processes:
Checklist
- Input data is identified and/or accessible via DDAS
- Input data is made accessible under an open license
- Analysis code is available on GitHub
- Analysis code is made accessible under an open license
- Workflow is sketched
- Analysis is split into reusable functions
- Input parameters are identified
- functions follow input - processing - output - logic
- input data can be passes via URL
- output data is stored in file, e.g., csv, json etc.
- Reusable functions are saved in separate files
- Runtime, libraries, and library versions identified
- R commands are added to README
- Analysis is dockerized
- Docker commands are added to README
- OGC API Processes created locally
- python scripts created
- titles and descriptions for input parameters added to json
- OGC API Processes deployed on server
- Tests successful
- Galaxy tool created locally
- Galaxy tool deployed on server
- Tests successful
- Workflow is complete