diff --git a/docs/about/License.md b/docs/about/License.md index 1681b3781..60f548314 100644 --- a/docs/about/License.md +++ b/docs/about/License.md @@ -5,10 +5,19 @@ license][cc-by-human]. The following is a human-readable summary of (and not a substitute for) the [full legal text of the CC BY 4.0 license][cc-by-legal]. -You are free: - -* to **Share**---copy and redistribute the material in any medium or format -* to **Adapt**---remix, transform, and build upon the material +You are free to: +
/g/data
(inserted as gdata/<project-ID>) and /scratch
(inserted as scratch/<project-ID>) data storage projects that will be available to the session.
+ /g/data
and /scratch
project folders you want to execute data I/O operations from.
+ <cmd>: cannot access '</path/to/file>': No such file or directory
+ module use </path/to/module/directory>
run on the command line.
+ module load <module-name>
run on the command line.
+ /apps/Modules/modulefiles
, you need to include the module directory in the Module directories option.
+ source <path/to/environment/bin/activate>
run on the command line.
+ conda activate <environment-name>
run on the command line.
+ -v
PBS directive.
+ <your-NCI-username>
with your NCI username (e.g., ab1234
):
+ssh <your-NCI-username>@gadi.nci.org.au
+You will be prompted to enter your NCI password, and then you will be connected to Gadi:
+ssh-keygen -t rsa -b 4096 -f ~/.ssh/id_gadi
+ You will be prompted to create a passphrase linked to the SSH key, which you will enter twice:
+ eval "$(ssh-agent -s)"
+ ssh-add --apple-use-keychain ~/.ssh/id_gadi
+ You will be prompted to enter your SSH key passphrase, which will be stored inside the SSH-agent:
+ --apple-use-keychain
flag with -K
.
+ ssh-add ~/.ssh/id_gadi
+ You will be prompted to enter your SSH key passphrase, which will be stored inside the SSH-agent:
+ ~/.ssh/config
is a file where you can store labelled SSH configurations for different remote servers you regularly connect to, so you do not have to remember them all.
+ touch ~/.ssh/config
+ ~/.ssh/config
file, the above command will not have any effect.
+ ~/.ssh/config
to describe the SSH configuration for Gadi (replace <your-NCI-username>
with your NCI username, e.g., ab1234
):
+ Host gadi
+ Hostname gadi.nci.org.au
+ User <your-NCI-username>
+ ForwardX11 true
+ ForwardX11Trusted yes
+ IdentityFile ~/.ssh/id_gadi
+ AddKeysToAgent yes
+ UseKeychain yes
+ ~/.ssh/config
file which contains configurations for every Host
(e.g., by using Host *
), make sure you delete any of the keywords present in that SSH configuration from the Gadi configuration above.
+ ~/.ssh/authorized_keys
.
+ var=$( cat ~/.ssh/id_gadi.pub ) && ssh gadi "echo $var >> .ssh/authorized_keys"
+ "
in the above command.
+ ssh gadi
+
+### Change default project on Gadi
+It is recommended that you check what your default project on Gadi is set to. The default project should be set to the computational project you will most likely use to run simulations/evaluations and store data.
+echo $PROJECT
+To change your default project on Gadi, you need to manually change the `PROJECT` field in the `~/.config/gadi-login.conf` file.
+sed "s/\(PROJECT \).*/\1<new-default-project>/" ~/.config/gadi-login.conf
+Once this is done, exit from Gadi and log back in.
+<your-NCI-username>
with your NCI username (e.g., ab1234
):
-ssh <your-NCI-username>@gadi.nci.org.au
-You will be prompted to enter your NCI password, and then you will be connected to Gadi:
-ssh-keygen -t rsa -b 4096 -f ~/.ssh/id_gadi
- You will be prompted to create a passphrase linked to the SSH key, which you will enter twice:
- eval "$(ssh-agent -s)"
- ssh-add --apple-use-keychain ~/.ssh/id_gadi
- You will be prompted to enter your SSH key passphrase, which will be stored inside the SSH-agent:
- --apple-use-keychain
flag with -K
.
- ssh-add ~/.ssh/id_gadi
- You will be prompted to enter your SSH key passphrase, which will be stored inside the SSH-agent:
- ~/.ssh/config
is a file where you can store labelled SSH configurations for different remote servers you regularly connect to, so you do not have to remember them all.
- touch ~/.ssh/config
- ~/.ssh/config
file, the above command will not have any effect.
- ~/.ssh/config
to describe the SSH configuration for Gadi (replace <your-NCI-username>
with your NCI username, e.g., ab1234
):
- Host gadi
- Hostname gadi.nci.org.au
- User <your-NCI-username>
- ForwardX11 true
- ForwardX11Trusted yes
- IdentityFile ~/.ssh/id_gadi
- AddKeysToAgent yes
- UseKeychain yes
- ~/.ssh/config
file which contains configurations for every Host
(e.g., by using Host *
), make sure you delete any of the keywords present in that SSH configuration from the Gadi configuration above.
- ~/.ssh/authorized_keys
.
- var=$( cat ~/.ssh/id_gadi.pub ) && ssh gadi "echo $var >> .ssh/authorized_keys"
- "
in the above command.
- ssh gadi
-
-### Change default project on Gadi
-It is recommended that you check what your default project on Gadi is set to. The default project should be set to the computational project you will most likely use to run simulations/evaluations and store data.
-echo $PROJECT
-To change your default project on Gadi, you need to manually change the `PROJECT` field in the `~/.config/gadi-login.conf` file.
-sed "s/\(PROJECT \).*/\1<new-default-project>/" ~/.config/gadi-login.conf
-Once this is done, exit from Gadi and log back in.
-