Quickstart: Using CyVerse for a Shared Project
Set up a collaborative imaging project using CyVerse |Bisque|.
Downloads, access, and services
In order to complete this tutorial you will need access to the following services/software
Prerequisite Preparation/Notes Link/Download CyVerse account You will need a CyVerse account to complete this exercise |CyVerse User Portal| Bisque access Request access to Bisque on the user portal |CyVerse User Portal|
The following CyVerse platform(s) can be used in a collaborative project:
|Platform||Interface||Link||Platform Documentation||Quick Start|
|Data Store||GUI/Command line|||Data Store||||Data Store Manual||||Data Store Guide||
|Discovery Environment||Web/Point-and-click|||Discovery Environment||||DE Manual||||Discovery Environment Guide||
Input and example data
No example data are required for this quickstart.
- Any project members who will be using CyVerse should take a look at the |Data Store Guide| and the |Discovery Environment Guide|.
- Be sure that all project members register for CyVerse accounts at the |CyVerse User Portal| and request access to Bisque. This action will create a directory in their home folder called bisque_data.
Managing a shared Bisque project
This quickstart is in progress. Please check back soon for the complete quickstart.
Managing a shared project with |Bisque| has some extra considerations, because image files are in Bisque are organized into Datasets. Images files that are organized and shared using the Data Store (e.g., using the DE interface) can still be accessed via the image browser in Bisque, but they will not be organized as in the Data Store (add link to more in Bisque manual). If the Bisque web viewer or API are not needed, shared imaging projects can be managed using the |Data Store| just as for Managing a regular group project. Follow the guide below to decide how best to manage your project.
Choose the management workflow that best fits your project
CyVerse calls itself the "Lego building blocuks of cyberinfrastructure", which means there are dozens of ways to set up a shared imaging project. Below are some methods that we have found work well. If you have other suggestions, please let us know!
Manage image data through the Bisque UI
When is this a good option? * Project members need to preview images * Project members need to add graphical annotations * Project uses Bisque apps for analyzing images
Manage image data through the Data Store in shared folder
When is this a good option? * Project data are shared only with project members
Manage image data through the Data Store in Community Released folder
When is this a good option? * Most of the project data are public
Sharing image data with project members
We strongly recommend that a single person be in charge of data management. There should also be a single person (generally the PI) who has ownership of the project folders and who sets read and write permissions for others. This ensures continuity when people move on. The PI can give ownership to a data manager for setting permissions, but should maintain their own ownership as well.
The owner of a folder has the ability to delete or rename the folder and any of its contents. If project members are given write permission to the project folder, they will be able to create their own sub-folders which they will own. In this way, project members can control access to their own data.
Before beginning your project, make a plan for how to name files and organize datasets. Remember that like traditional folders, datasets in Bisque can be nested, so you can have one overarching dataset, with sub-datasets. Agree on which metadata are needed for each type of file, and set up protocols for adding metadata when files are uploaded.
Sharing of images can be done through the |Bisque| interface or the |Discovery Environment| via the data sharing feature or on the command line using iCommands. Project members also can upload and download data using the desktop application Cyberduck, but Cyberduck cannot be used for setting sharing permissions.
According to the CyVerse Data Policy, all users receive a default allocation of 100GB. Shared data is counted as part of the allocation of whoever owns the folder that contains it. To request an increase to your allocation, should that become necessary, use the allocation increase form. We expect that users hosting shared directories will need to request larger data allocations.
If your project needs a shared folder for data that that going to be public during the active research phase of the project (e.g., you want to share transcriptomes or draft genomes as they are created, before publication), you can request a Community Released Data Folder. Community Released folders are intended for public data, not for shared projects that are kept private among collaborators.
Additional information, help
Fix or improve this documentation