Difference between revisions of "CLEX Roadmap"

Line 1: Line 1:
  
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">[[.dmponline.cloud.edu.au|CLEX Roadmap]] is a web based tool we provide to help creating,&nbsp;storing and sharing data management plans (DMPs).&nbsp;The original Roadmap has been developed by the&nbsp;[http://dcc.ac.uk/ Digital Curation Centre]&nbsp;and the&nbsp;[https://www.cdlib.org/uc3/ University of California Curation Center (UC3)]. Our&nbsp;version has also been adapted&nbsp;to manage allocation of temporary storage in /g/data/hh5/tmp at NCI (see [[Storage|storage page]]).</span></span>
+
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">[[.dmponline.cloud.edu.au|CLEX Roadmap]] is a web-based tool we provide to help creating,&nbsp;storing and sharing data management plans (DMPs).&nbsp;The original Roadmap has been developed by the&nbsp;[http://dcc.ac.uk/ Digital Curation Centre]&nbsp;and the&nbsp;[https://www.cdlib.org/uc3/ University of California Curation Center (UC3)]. Our&nbsp;version has also been adapted&nbsp;to manage allocation of temporary storage in /g/data/hh5/tmp at NCI (see [[Storage|storage page]]).</span></span>
  
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">Anyone who is associated to CLEX can have an account, however&nbsp;we do use a valid email list to check that you are authorised. If your email is not in th elist you will receive a warning and we will receive a notification, we will then add your email asap.&nbsp;</span></span>
+
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">Anyone who is associated to CLEX can have an account, however&nbsp;we do use a valid email list to check that you are authorised. If your email is not in the list you will receive a warning and we will receive a notification, we will then add your email asap.&nbsp;</span></span>
  
[[File:Roadmap mydashboard.png|800px]]
+
[[File:Roadmap mydashboard.png|800px|Roadmap mydashboard.png]]
  
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">When you log in to DMPRoadmap you will be directed to the 'My Dashboard' page, shown above. From here you can edit, share, download, copy or remove any of your plans. You will also see plans that have been shared with you by others.</span></span>
+
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">When you log in to CLEX&nbsp;Roadmap you will be directed to the 'My Dashboard' page, shown above. From here you can edit, share, download, copy or remove any of your plans. You will also see plans that have been shared with you by others.</span></span>
  
 
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">On the navigation tab at the top of the page you can also select to create a new plan, apply for storage or&nbsp;view all your storage allocations.</span></span>
 
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">On the navigation tab at the top of the page you can also select to create a new plan, apply for storage or&nbsp;view all your storage allocations.</span></span>
  
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">The CLEX [[Roadmap_user_guide]]&nbsp;shows in more detail,&nbsp;how to create an account, submit&nbsp;a storage request and create a new plan. Here, we provide just an overview.</span></span>
+
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">The CLEX [[Roadmap_user_guide|Roadmap_user_guide]]&nbsp;shows in more detail,&nbsp;how to create an account, submit&nbsp;a storage request and create a new plan. Here, we provide just an overview.</span></span>
  
 
=== '''<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">Plans</span></span>''' ===
 
=== '''<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">Plans</span></span>''' ===
Line 18: Line 18:
 
*<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">Basic DMP - is a complete DMP&nbsp;in itself. It&nbsp;can be used as an attachment to a grant application</span></span>  
 
*<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">Basic DMP - is a complete DMP&nbsp;in itself. It&nbsp;can be used as an attachment to a grant application</span></span>  
 
*<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">Provenance - is a set of questions that helps you putting together your data provenance, producing more detailed metadata and keeping track of your data workflow</span></span>  
 
*<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">Provenance - is a set of questions that helps you putting together your data provenance, producing more detailed metadata and keeping track of your data workflow</span></span>  
*<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">Publishing DMP - is used to collect details of a completed dataset to help with its publication. The answers to this questions will be exported to create metadata records for&nbsp;the repositories we use to publish. They&nbsp;will also be used to annotate the dataset NetCDF files. This is why some of these require specific formats.</span></span>  
+
*<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">Publishing DMP - is used to collect details of a completed dataset to help with its publication. The answers to these questions will be exported to create metadata records for&nbsp;the repositories we use to publish. They&nbsp;will also be used to annotate the dataset NetCDF files. This is why some of these require specific formats.</span></span>  
  
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">More information on how to create and manage a plan is also available in the [[Roadmap_plans]] page.</span></span>
+
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">More information on how to create and manage a plan is also available in the [[Roadmap_plans|Roadmap_plans]] page.</span></span>
  
== Create a plan ==
+
== '''<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">Storage allocations</span></span>''' ==
  
To create a plan, click the 'Create plan' button from the 'My Dashboard' page or the top menu. Select options from the menus and tickboxes to determine what questions and guidance you should be presented with. Confirm your selection by clicking 'Create plan.'
+
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">The disk storage available in the NCI hh5 project is used as a shared resource, for anyone who need temporarily some extra disk to analyse data. CLEX Roadmap helps us to manage&nbsp;these allocations as we can use to record some&nbsp;essential information: the size of the allocation, who is responsible and what data will be stored there.</span></span>
  
You will now have access to the 'write plan' interface. Currently we only one one available template "CLEX template" so thsi will always be the same.
+
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">This information helps us:</span></span>
  
The tabbed interface allows you to navigate through different functions when editing your plan.
+
*<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">to prioritise and efficiently and equitably allocated the shared storage based on users' needs</span></span>
 +
*<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">individuate&nbsp;quickly who is responsible for the stored data should there be any issue with it</span></span>
 +
*<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">manage the file access&nbsp;permissions&nbsp;</span></span>
 +
*<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">take decisions on the data if left back after a user move to a different position</span></span>
  
*'Project Details' includes basic administrative details.
+
<span style="font-size:medium;"><span style="font-family:Arial,Helvetica,sans-serif;">For more details on the process you can also check the [[Storage-request|storage request]] page.</span></span>
*'Plan Overview' tells you what template and guidance your plan is based on and gives you an overview to the questions that you will be asked.
 
*Collaborators - you can use this add collaborators to your plan, defining their role. Differently from when you share a plan (see below), they do not need to have an account to be listed.
 
*The following tabs present each a set of questions for each of our&nbsp;three phases: 'Basic DMP', 'Provenance' and 'Publishing DMP"  
 
*'Share' allows you to invite others to read or contribute to your plan.
 
*'Download' allows you to download your plan in various formats. This may be useful if you need to submit your plan as part of a grant application.  
 
  
When viewing any of the question tabs, you will see the different sections of your plan displayed. Click into these in turn to answer the questions. You can format your responses using the text editing buttons.
+
&nbsp;
  
Guidance is displayed in the right-hand panel. Not all the available guidance shows by default you can show/hide the available guidances by clicking on their headers.
+
[[Category:Data induction]]
 
 
== Share plans ==
 
 
 
Insert the email address of any collaborators you would like to invite to read or edit your plan. Set the level of permissions you would like to grant them via the radio buttons and click to 'Add collaborator.' Adjust permissions or remove collaborators at any time via the drop-down options.
 
 
 
The ‘Share’ tab is also where you can set your plan visibility.
 
 
 
*Private: restricted to you and your collaborators.
 
*Organisational: anyone at your organisation can view your plan.
 
*Public: anyone can view your plan in the Public DMPs list.
 
 
 
By default all new and test plans will be set to ‘Private’ visibility. ‘Public’ and ‘Organisational’ visibility are intended for finished plans. You must answer at least 50% of the questions to enable these options.
 
 
 
NB. to share with a&nbsp;collaborator they also need to have an account, you then share with the email they use for it.&nbsp;
 
 
 
&nbsp;
 

Revision as of 02:46, 15 July 2021

CLEX Roadmap is a web-based tool we provide to help creating, storing and sharing data management plans (DMPs). The original Roadmap has been developed by the Digital Curation Centre and the University of California Curation Center (UC3). Our version has also been adapted to manage allocation of temporary storage in /g/data/hh5/tmp at NCI (see storage page).

Anyone who is associated to CLEX can have an account, however we do use a valid email list to check that you are authorised. If your email is not in the list you will receive a warning and we will receive a notification, we will then add your email asap. 

Roadmap mydashboard.png

When you log in to CLEX Roadmap you will be directed to the 'My Dashboard' page, shown above. From here you can edit, share, download, copy or remove any of your plans. You will also see plans that have been shared with you by others.

On the navigation tab at the top of the page you can also select to create a new plan, apply for storage or view all your storage allocations.

The CLEX Roadmap_user_guide shows in more detail, how to create an account, submit a storage request and create a new plan. Here, we provide just an overview.

Plans

We provide a 'CLEX template' to create the plans, this template includes three separate phases. The phases reflect the different potential uses of a DMP, as we illustrated in the data management plan page.

  • Basic DMP - is a complete DMP in itself. It can be used as an attachment to a grant application
  • Provenance - is a set of questions that helps you putting together your data provenance, producing more detailed metadata and keeping track of your data workflow
  • Publishing DMP - is used to collect details of a completed dataset to help with its publication. The answers to these questions will be exported to create metadata records for the repositories we use to publish. They will also be used to annotate the dataset NetCDF files. This is why some of these require specific formats.

More information on how to create and manage a plan is also available in the Roadmap_plans page.

Storage allocations

The disk storage available in the NCI hh5 project is used as a shared resource, for anyone who need temporarily some extra disk to analyse data. CLEX Roadmap helps us to manage these allocations as we can use to record some essential information: the size of the allocation, who is responsible and what data will be stored there.

This information helps us:

  • to prioritise and efficiently and equitably allocated the shared storage based on users' needs
  • individuate quickly who is responsible for the stored data should there be any issue with it
  • manage the file access permissions 
  • take decisions on the data if left back after a user move to a different position

For more details on the process you can also check the storage request page.