Quick Start Guide¶
This guide will walk you through how to start using DolphinNext pipelines. First off, you need to enter DolphinNext web page: https://dolphinnext.umassmed.edu/ and click Sign Up or Sign in with Google buttons. You will be asked to enter your institute information. An email will be sent to you upon verification of your information.
Once you enter DolphinNext platform, Profile Wizard will open as shown at below.
If you have any issues/questions about creating profiles please contact us on: email@example.com
First, choose your profile type:
- If you have an access to High Performance Computing (HPC) environments, or personal workstations, then please choose Host.
- If you have an Amazon Web Services (AWS) account or planning to create one, then please choose Amazon and follow our Amazon Guide to create your run environment.
- If you have an Google Cloud account or planning to create one, then please choose Google and follow our Google Guide to create your run environment.
- If you choose MGHPCC cluster option, you can upload your files to our MGHPCC cluster to process your data and download your results from report section. However, you will not have direct access to our cluster.
If you choose MGHPCC option, you can skip the rest of this guideline and go to Running Pipelines Section.
Second, add public SSH Key into your host machine.
- Here, public key is securely generated for your account and required to be added into
~/.ssh/authorized_keysin the host by user. Please check our Adding Public SSH Key Section for help.
- After adding public key, please click Validate SSH Keys button to finalize this section.
* Username: yourusername (eg. us2r) * Hostname: yourhostname (eg. ghpcc06.umassrc.org)
- Third, install/validate software dependencies into the host machine.
In order to execute our pipelines, Nextflow should be installed into your host environment. Besides, most of our pipelines isolates their dependencies within their Docker or Singularity containers, therefore please install these softwares into your machine by following guidelines. If your platform doesn’t support the installation of Docker, you can still use our pipelines by just using Singularity.
Sofware Dependencies Section:
- JAVA Command (optional): If JAVA is not added to $PATH environment, you can run command (eg.
module load java/8.0) to manipulate your $PATH environment and gain access to JAVA.
- Nextflow Path or Command (optional): If nextflow is not added to $PATH environment, you can either enter the path of the nextflow (eg.
/project/bin), or run command (eg.
module load nextflow) to manipulate your $PATH environment and gain access to new softwares.
- Docker/Singularity Command (optional): You can run command to manipulate your $PATH environment in order to gain access to new softwares. (eg.
module load docker/1.0.0or
module load singularity/3.0.0)
General run settings could be set in following Run settings section:
- Executor of Nextflow: Nextflow itself is initiated with this method and it will be only used for running nextflow itself.
- Executor of Nextflow Jobs: This setting will be used as default setting for submitted jobs by Nextflow.
- Download Directory: Used to download shared pipeline files such as genome indexes. If your platform has already such path, please enter that location. Otherwise you can set any path that you have permission to write. e.g.
Once you complete these steps, you’re now able to start using publicly available pipelines.
The easiest way to run pipeline is using main page by clicking the Biocore DolphinNext button at the top left of the screen. Now, you can investigate publicly available pipelines as shown at below and select the pipeline you want run by clicking Learn More button.
Once pipeline is loaded, you will notice “Run” button at the right top of the page.
This button opens new window where you can create new project by clicking “Create a Project” button. After entering and saving the name of the project, it will be added to your project list. Now you can select your project by clicking on the project as shown in the figure below.
Now, you may proceed with entering run name which will be added to your run list of the project. Clicking “Save run” will redirect to “run page”.
Initially, in the header of the run page, orange
Waitingbutton will be shown. In order to initiate run, following data need to be entered:
Work Directory: Full path of the directory, where nextflow runs will be executed.
Inputs: Value and path of the files need to be entered. For detailed information please check adding files section.
Once all requirements are satisfied,
Waitingbutton will turn in to green
ready to runbutton as shown below. You can initiate your run by clicking
ready to runbutton. Please go through run page for detailed explanation about each module is used.
You can reach your remote files by entering:
- Full path of a directory: eg.
- Web link: eg.
- Amazon (S3) Bucket: eg.
- Google (GS) Bucket: eg.
If you want to download and use NCBI (GEO data) in the pipeline, you can simply use GEO Files tab. Here are the few examples for GEO ID:
If you need to upload your local files and transfer into Target Directory in the Host, you can use Upload Files tab.
For detailed information about adding files, please check our tutorial video: