Welcome to the community repository for the BioExcel Building Blocks Workflows. In this repo there are all the workflows developed by the community members. If you want to take a look to the BioBB demonstration workflows, please visit the BioExcel Building Blocks Workflows repository.
If you have developed a workflow using BioExcel Building Blocks, you can contribute to this repository doing a Pull Request. Please follow the steps defined in this section.
Click the "Fork" button at the top-right corner of this repository page. This will create a copy of the repository under your GitHub account.
Go to your GitHub profile and find the forked biobb_community_wfs repository under your profile. Then, click the "Code" button on the repository page and copy the repository URL (HTTPS/SSH). Open your terminal and run:
git clone <repository-url>
Run the following command to create and switch to a new branch:
git checkout -b <branch-name>
It's recommended to name the new branch after the new workflow name (ie biobb_wf_md_setup).
Now, copy your workflow into the repository. Please use the following file structure:
📂 workflow_name_main_folder
- 📖 README.md
- 📁 workflow_name_subfolder
Where:
It's the name of your workflow starting by the prefix biobb_wf_ (ie biobb_wf_md_setup)
It's a copy of the README-template.md file that can be found in this same repository. Add here all the information needed in order to install and run the workflow.
It's the name of your workflow starting by the prefix biobb_wf_ (ie biobb_wf_md_setup).
This folder must be a GitHub submodule for the sake of improving the maintenance of this repository. For creating a new submodule from your own repo, please type the following instruction:
git submodule add [email protected]:path_to/submodule.git <workflow_name_subfolder>
Stage the Changes:
git add .
Commit the Changes:
git commit -m "Added new XXXX wf"
Push Changes to GitHub (don't forget to push the current branch):
git push origin <branch-name>
Go to the original repository https://github.com/bioexcel/biobb_community_wfs.
In this repo, GitHub should detect the new branch and show a "Compare & pull request" button. Click it.
Alternatively, go to the "Pull Requests" tab and click the "New pull request" button.
Select Branches: ensure the base fork (original repository) and its default branch (usually main or master) are selected, and compare it with the head fork (your repository) and your branch.
Fill Out the PR Form: provide a title and description for your PR. Describe what changes you made and why they are necessary. Click the "Create pull request" button.
This software has been developed in the MMB group at the BSC & IRB for the European BioExcel, funded by the European Commission (EU H2020 823830, EU H2020 675728).
- (c) 2015-2024 Barcelona Supercomputing Center
- (c) 2015-2024 Institute for Research in Biomedicine
Licensed under the Apache License 2.0, see the file LICENSE for details.
