Accessing HydroShare iRODS from a Windows PC or Mac

HydroShare offers an iRODS Users area to work with HydroShare resources.  This Users area is especially well suited for handling large files, e.g. > 1GB, that are often too large to be handled well or at all by http protocols. Note that you must have an existing HydroShare account and HydroShare iRODS Users area account before proceeding.

Herein it is documented how to access the HydroShare iRODS Users area with a third-party Windows and Mac application called CyberDuck.  CyberDuck is a free open source application that supports many transfer protocols (e.g. FTP, SFTP, WebDAV, Azure, Amazon S3, etc.).  As of version 4.7.1 and later, CyberDuck also supports the iRODS protocol.  The iRODS protocol support within CyberDuck, when configured properly, is optimized for working with large files more efficiently than the http protocol is able to in the absence of iRODS.  Since HydroShare is a web-based environment, this approach of using iRODS addresses the handling of large files that otherwise would be impractical or imposible to handle via a web http interface. Following are the steps to install and configure CyberDuck for use with the HydroShare iRODS Users area.

Step One: Download the CyberDuck Profile for the HydroShare iRODS Users Area

Download the file HydroShareUsers.cyberduckprofile from HydroShare here and place it on your desktop (but don't run it yet): https://www.hydroshare.org/resource/87f5341f93b944a7bb6e21c0745cb167/ 

CyberDuck HydroShare iRODS Profile for Users Area

Step Two: Install CyberDuck, But Don't Run It Yet

Download and install this particular version of CyberDuck for your Windows PC or Mac from here (but don't run it yet, and note the most recent version of CyberDuck from the CyberDuck website does not work with HydroShare): https://www.hydroshare.org/resource/be53cf62a2a0408aadeebdc781d83475/ 

Step Three: Don't Run CyberDuck, Rather Run the CyberDuck Profile Downloaded in Step One Above (and don't user or upgrade CyberDuck to a newer version of CyberDuck than 5.2.3)

Don't run CyberDuck.  Rather, select and run the HydroShareUsers.cyberduckprofile file downloaded in Step One.  If your Windows PC or Mac doesn't know what program to associate with its executation, associate the cyberduck executable (e.g. cyberduck.exe) with its execution.  If the following CyberDuck window pops up, close it without entering any information in it:

CyberDuck ignore popup

Next, double-click to run the "users.hydroshare.org - IRODS" bookmark that shows up in the CyberDuck window.  If multiple "users.hydroshare.org - iRODS" bookmarks show up, choose any one that says "users.hydroshare.org - IRODS" and allows you to successfully double-click and run it without a "Connection failed...Try Again" error message (you can delete any unwanted or non-working bookmark entries by selecting them and hitting the "Delete" key, or by selecting and right-clicking them and choosing "Delete Bookmark").

CyberDuck Profile

Next, enter your HydroShare iRODS credentials in the popup box, and X the Save password box if desired:

CyberDuck HydroShare login popup

Step Four: Before Transferring A File for the First Time, Configure CyberDuck for Fast File Transfers

In the Edit pull-down menu of the main CyberDuck window (not shown), choose Preferences, then choose the Transfers tab at the top and make sure the Transfer Files: setting is set to Open multiple connections.

CyberDuck Multiple Connections

Next, choose the General tab at the top and make sure the Default protocol: is set to HydroShare Users Data Store.  It is very important that you set this or your login credintials to users.hydroshare.org will not work.

CyberDuck General tab

Step Five: Begin Transferring a File, and Maximize Number of Multiple Connections

Select a file you would like to download.  In the following example, the 2.7 Gigabyte file US.gdb.zip is shown.

CyberDuck transfer window

Next, in the lower right of the active CyberDuck Transfers window, next to the turtle icon increase the numerical value representing the number of multiple connections used for transfer to the maximum value,  i.e. 9.

CyberDuck transfer progress

Success! Your file is now uploaded to IRODS.

CyberDuck has now been successfully configured to transfer files efficiently to/from a Windows PC or Mac to/from the HydroShare iRODS Users area.

If you would like to access additional helpful information about CyberDuck, please access their help and FAQ web page here: https://trac.cyberduck.io/wiki/help/en 

If you would like to access additional helpful information about iRODS, please see: http://irods.org/about/overview/ 

Next, you are ready to Create a New Resource in HydroShare (Uploading Large Files into HydroShare).