Skip to content

Commit 26205ff

Browse files
committed
📝 Update user guide
1 parent d754015 commit 26205ff

File tree

1 file changed

+27
-23
lines changed

1 file changed

+27
-23
lines changed

docs/source/roles/researcher/user_guide.md

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -686,37 +686,38 @@ If you need to use a package that is not on the allowlist see the section on how
686686

687687
There are several shared areas on the SRD that all collaborators within a research project team can see and access:
688688

689-
- [input data](#input-data-data): `/data/`
690-
- [shared space](#shared-space-shared): `/shared/`
691-
- [scratch space](#scratch-space-scratch): `/scratch/`
692-
- [backup space](#backup-space-backup): `/backup/`
693-
- [output resources](#output-resources-output): `/output/`
689+
- [input data](#input-data): `/mnt/input/`
690+
- [shared space](#shared-space): `/mnt/shared`
691+
<!-- - [scratch space](#scratch-space-scratch): `/scratch/` -->
692+
<!-- - [backup space](#backup-space-backup): `/backup/` -->
693+
- [output resources](#output-resources): `/mnt/output`
694694

695-
#### Input data: `/data/`
695+
#### Input data
696696

697-
Data that has been "ingressed" - approved and brought into the secure research environment - can be found in the `/data/` folder.
697+
Data that has been "ingressed" - approved and brought into the secure research environment - can be found in the `/mnt/input` folder.
698698

699699
Everyone in your group will be able to access it, but it is **read-only**.
700700

701701
```{important}
702-
You will not be able to change any of the files in `/data/` .
703-
If you want to make derived datasets, for example cleaned and reformatted data, please add those to the `/shared/` or `/output/` directories.
702+
You will not be able to change any of the files in `/mnt/input` .
703+
If you want to make derived datasets, for example cleaned and reformatted data, please add those to the `/mnt/shared` or `/mnt/output` directories.
704704
```
705705

706-
The contents of `/data/` will be **identical** on all SRDs in your SRE.
707-
For example, if your group requests a GPU-enabled machine, this will contain an identical `/data/` folder.
706+
The contents of `/mnt/input` will be **identical** on all SRDs in your SRE.
707+
For example, if your group requests a GPU-enabled machine, this will contain an identical `/mnt/input` folder.
708708

709709
```{tip}
710-
If you are using the Data Safe Haven as part of an organised event, you might find example slides or document templates in the `/data/` drive.
710+
If you are using the Data Safe Haven as part of an organised event, you might find example slides or document templates in the `/mnt/input` drive.
711711
```
712712

713-
#### Shared space: `/shared/`
713+
#### Shared space
714714

715-
The `/shared/` folder should be used for any work that you want to share with your group.
715+
The `/mnt/shared` folder should be used for any work that you want to share with your group.
716716
Everyone in your group will be able to access it, and will have **read-and-write access**.
717717

718-
The contents of `/shared/` will be **identical** on all SRDs in your SRE.
718+
The contents of `/mnt/shared` will be **identical** on all SRDs in your SRE.
719719

720+
<!--
720721
#### Scratch space: `/scratch/`
721722
722723
The `/scratch/` folder should be used for any work-in-progress that isn't ready to share yet.
@@ -727,7 +728,9 @@ You should not use `/scratch/` for long-term storage as it can be reset at any t
727728
```
728729
729730
The contents of `/scratch/` will be **different** on different VMs in your SRE.
731+
-->
730732

733+
<!--
731734
#### Backup space: `/backup/`
732735
733736
The `/backup/` folder should be used for any work-in-progress that you want to have backed up.
@@ -736,15 +739,16 @@ This **cannot** be used to recover individual files - only the complete contents
736739
Everyone in your group will have **read-and-write access** to all folders on `/backup`.
737740
738741
The contents of `/backup/` will be **identical** on all SRDs in your SRE.
742+
-->
739743

740-
#### Output resources: `/output/`
744+
#### Output resources
741745

742-
Any outputs that you want to extract from the secure environment should be placed in the `/output/` folder on the SRD.
746+
Any outputs that you want to extract from the secure environment should be placed in the `/mnt/output` folder on the SRD.
743747
Everyone in your group will be able to access it, and will have **read-and-write access**.
744748
Anything placed in here will be considered for data egress - removal from the secure research environment - by the project's principal investigator together with the data provider.
745749

746750
```{tip}
747-
You may want to consider having subfolders of `/output/` to make the review of this directory easier.
751+
You may want to consider having subfolders of `/mnt/output` to make the review of this directory easier.
748752
```
749753

750754
```{hint}
@@ -793,12 +797,12 @@ One of the benefits of having cloud based infastructure is that it can be delete
793797
Deleting the infrastructure ensures that neither sensitive data nor insights derived from the data or modelling techniques persist.
794798

795799
While working on the project, make sure that every piece of code you think might be useful is stored in a GitLab repository within the secure environment.
796-
Any other work should be transferred to the `/shared/` drive so that it is accessible to other TRE users.
797-
You can also use the `/backup/` drive to store work that you want to keep safe from accidental deletion.
798-
Anything that you think should be considered for **egress** from the environment (eg. images or processed datasets) should be transferred to the shared `/output/` drive.
800+
Any other work should be transferred to the `/mnt/shared` drive so that it is accessible to other TRE users.
801+
<!-- You can also use the `/backup/` drive to store work that you want to keep safe from accidental deletion. -->
802+
Anything that you think should be considered for **egress** from the environment (eg. images or processed datasets) should be transferred to the shared `/mnt/output` drive.
799803

800804
```{caution}
801-
Anything that is not transferred to the `/output/` drive to be considered for egress will be deleted forever when the project is over.
805+
Anything that is not transferred to the `/mnt/output` drive to be considered for egress will be deleted forever when the project is over.
802806
```
803807

804808
### {{unlock}} Access GitLab
@@ -943,7 +947,7 @@ Our example user, Ada Lovelace, participating in the `sandbox` project at a Turi
943947
````
944948

945949
- This will bring you to the normal login screen, where you use the same `username` and `password` credentials as before.
946-
- Any local files that you have created in the `/output/` folder on other VMs (e.g. analysis scripts, notes, derived data) will be automatically available in the new VM.
950+
- Any local files that you have created in the `/mnt/output` folder on other VMs (e.g. analysis scripts, notes, derived data) will be automatically available in the new VM.
947951

948952
```{tip}
949953
The naming pattern of the available desktop connections lets you know their compute capabilities.

0 commit comments

Comments
 (0)