diff --git a/README.md b/README.md index d476cbea53ee6d4eb7fe5b4350fa129389576de4..b0f391c524f74669e2d2bf42ec95a2ac32a02b30 100644 --- a/README.md +++ b/README.md @@ -84,6 +84,8 @@ Otherwise please join the `PADC` and `CPADC` projects. ## 4. Logging on to the supercomputers +**Note:** From here on it is assumed that you already have an account on your required supercomputer. + ### 4.1 JURECA Following are the steps required to login (more information @@ -92,15 +94,22 @@ Following are the steps required to login (more information 1. Use SSH to login: `ssh <username>@jureca.fz-juelich.de` -2. Upon successful login, activate your project environment (more information [here](http://www.fz-juelich.de/ias/jsc/EN/Expertise/Supercomputers/NewUsageModel/NewUsageModel_node.html)): +2. Upon successful login, activate your project environment: - `jutil env activate -p <project name> -A <accounting project name>` + `jutil env activate -p <name of compute project> -A <name of budget>` + + **Note:** To view a list of all project and budget names available to you, please use the following command: `jutil user projects -o columns`. + Under the column titled "project", all names that start with the prefix "c" are compute projects, and + can be used in the `<name of compute project>` field for the command above. The `<name of budget>` field should then + contain the corresponding name under the "budgets" column. Please click [here](http://www.fz-juelich.de/ias/jsc/EN/Expertise/Supercomputers/NewUsageModel/NewUsageModel_node.html) + for more information. 3. Change to the project directory: `cd $PROJECT` -You should be in your project directory at this point. If you'd like to clone this repository -elsewhere, please change to that directory. +You should be in your project directory at this point. As the project directory is shared with other project +members, it is recommended to create a new directory with your username, and change to that directory. If +you'd like to clone this repository elsewhere, please change to the directory of your choice. ### 4.2 JURON @@ -111,18 +120,22 @@ Following are the steps required to login. `ssh <username>@juron.fz-juelich.de` 2. Upon successful login, activate your project environment (more information [here](http://www.fz-juelich.de/ias/jsc/EN/Expertise/Supercomputers/NewUsageModel/NewUsageModel_node.html)). - Note that the accounting project name is not included. This is because the `CPCP0` and `CPADC` projects - do not support accounting. - `jutil env activate -p <project name>` + `jutil env activate -p <name of compute project>` + + The `<name of compute project>` can be either `CPCP0` or `CPADC`, depending on whether you are a member + of `CPCP0` or `CPADC` (to view a list of all project names available to you, please use the following + command: `jutil user projects -o columns`). Note that as opposed to the corresponding section on JURECA, + the `<name of budget>` is not included. This is because the `CPCP0` and `CPADC` projects do not support + accounting. 3. Change to the project directory: `cd $PROJECT` You should be in your project directory at this point. As the `CPCP0` and `CPADC` project directories -are shared amongst many users, it is a good idea to create a personal directory (named after your -username) withing the project directory. You can then use your personal directory for all your work, -including cloning this tutorial. +are shared amongst many users from different institutes and organizations, it is recommended to create +a personal directory (named after your username) withing the project directory. You can then use your +personal directory for all your work, including cloning this tutorial. ## 5. Cloning the repository @@ -130,9 +143,6 @@ In order to store the datasets within the repository, we use Git LFS. This makes repository a little bit different. Please find below the instructions on how to clone on different systems. To learn more about Git LFS, click [here](http://gitlab.pages.jsc.fz-juelich.de/lfs/). -**Note:** During the cloning process you will most likely be prompted for your username and -password twice; this is as expected. - ### 5.1 JURECA 1. Load the Git LFS module: @@ -147,8 +157,8 @@ password twice; this is as expected. ### 5.2 JURON -No additional setup is required on JURON. You can simply clone the repository along with the -datasets using the following command: +The process is simpler on JURON. You can simply clone the repository along with the datasets using +the following command: git lfs clone https://gitlab.version.fz-juelich.de/khalid1/ml_dl_on_supercomputers.git @@ -160,10 +170,13 @@ the steps required for different supercomputers. ### 6.1 JURECA -1. Assuming you are in the repository root, change to the keras directory: +1. Change directory to the repository root: + + `cd ml_dl_on_supercomputers` +2. Change to the keras sub-directory: `cd keras` -2. Submit the job to run the sample: +3. Submit the job to run the sample: `sbatch submit_job_jureca_python3.sh` @@ -179,10 +192,13 @@ configuration. ### 6.2 JURON -1. Assuming you are in the repository root, change to the keras directory: +1. Change directory to the repository root: + + `cd ml_dl_on_supercomputers` +2. Change to the keras sub-directory: `cd keras` -2. Submit the job to run the sample: +3. Submit the job to run the sample: `bsub < submit_job_juron_python3.sh` @@ -230,4 +246,4 @@ directory-local `README.md` for further information. * **Created by:** Fahad Khalid (SLNS/HPCNS, JSC) * **Installation of modules on JURON:** Andreas Herten (HPCNS, JSC) * **Installation of modules on JURECA:** Damian Alvarez (JSC), Rajalekshmi Deepu (SLNS/HPCNS, JSC) -* **Review/suggestions/testing:** Kai Krajsek (SLNS/HPCNS, JSC), Tabea Kirchner (SLNS/HPCNS, JSC) +* **Initial review/suggestions/testing:** Kai Krajsek (SLNS/HPCNS, JSC), Tabea Kirchner (SLNS/HPCNS, JSC)