WP5 workflows registration/update on WorkflowHub – Instructions from WP2

Dear ESG WP5 members, As discussed during our last WP5 meeting, I’m pleased to share the detailed instructions from Eli Chadwick (WP2) regarding the registration of workflows on WorkflowHub. These steps are important to ensure all workflows developed with ESG funding are properly documented, findable, and citable for the final EuroScienceGateway report. Please review Eli’s message below carefully. If you have any questions, feel free to reach out to either Eli or me directly. Best regards, Armin *Message from Eli Chadwick (WP2):* Hi ESG WP5 members, As we approach the end of the EuroScienceGateway project, as part of WP2 we need to ensure that all the computational workflows developed with ESG funding are registered on WorkflowHub <https://workflowhub.eu/> and linked to the ESG Team <https://workflowhub.eu/projects/166#workflows>, so that they are readily findable and so that we can cite them in the final report. This includes workflows developed in WP5. We have created the EuroScienceGateway Guide to WorkflowHub <https://workflowhub.eu/sops/8/content_blobs/534/view_content> to help you to register your workflows, and I've summarized the necessary steps below. I will come along to the next WP5 meeting to check in - please make sure your workflows are linked to the ESG Team by then, even if they aren't completely ready to publish. *If you need to register workflows:* * Follow the guide linked above to register your workflows, including minting DOIs for them. *If you have workflows registered already:* * Check that your workflows are *linked to* the EuroScienceGateway Team <https://workflowhub.eu/projects/166> on WorkflowHub. They should appear in this list: https://workflowhub.eu/projects/166#workflows. If your workflows are not linked to the ESG Team, we do not know that they exist! o To add your workflow to the Team, click "Actions" > "Manage Workflow", then select the EuroScienceGateway Team (you may need to request to join the team first if you are not already a member). * Check that your workflows are*up to date*. If you have made changes to the workflow since its "Last updated" date on WorkflowHub, you should create a new version (do not re-register the workflow from scratch). o See the "Keeping workflows up-to-date" section of the guide for how to update a workflow and its metadata. * If your workflow is ready to be cited in the final report, *mint a DOI* for the workflow. You should reference this DOI when mentioning the workflow in the final report. o See the "Publishing workflows" section of the guide for the steps to create a DOI. If your workflow was registered by somebody else (such as the batch submitted in Feb 2024), the submitter can give you permission to manage the workflow to complete the steps above - so contact them if needed (or contact me if you don't know how to get in touch with them). *If you have used someone else's workflow for ESG-related work:* * Assuming the workflow is already on WorkflowHub, add it to the "Workflows in EuroScienceGateway <https://workflowhub.eu/collections/13>" Collection (this is separate to the Team) - see the "Adding and removing a Workflow to one of the EuroScienceGateway collections" section of the guide for how to do this. You do not need to be an owner of the workflow. * An example might be if you used a pre-existing workflow from the GTN for an ESG-related training workshop. If you have questions or need any help, let me know! Thanks, Eli -- Eli Chadwick (he/him and they/them) Senior Research Software Engineer University of Manchester eli.chadwick@manchester.ac.uk
participants (1)
-
Armin Dadras