diff --git a/README.md b/README.md index 9569287578dceb37c2c270536b4743d940f89e42..52b3663d342b0a943dc63ef106a411ed93582ee1 100644 --- a/README.md +++ b/README.md @@ -16,10 +16,11 @@ Building your base singularity image is a crucial step in preparing your environ Once you have reviewed the repository details and determined the appropriate Python version, you can proceed to build the base Python image using the following command: ```bash -bash scripts/build_base_image.sh -A {account} -p {partition} -V {python_version} -N {base_image_name} +bash scripts/build_base_image.sh -A {account} -G {Group_name} -p {partition} -V {python_version} -N {base_image_name} ``` -- `account`: The account name for using supercomputers. -- `partition`: The partition name on the supercomputer. Please use a partition that has internet access (e.g., `devel`, `develgpus`, `develbooster`, etc.). +- `account`: The account name for using supercomputers (you can find the name of the budget on JuDoor). +- `Group_name`: The group name for using supercomputers (you can find the name of the Group on JuDoor). Sometimes account and group name are the same. +- `partition`: The partition name on the supercomputer. Please use a partition that has internet access (e.g., `devel`, `develgpus`, `develbooster`, `all (JEDI)`, etc.). - `python_version`: The Python version (e.g., `3.10`). - `base_image_name`: The name of the base image with a `.sif` extension (e.g., `base.sif`). @@ -27,14 +28,14 @@ bash scripts/build_base_image.sh -A {account} -p {partition} -V {python_version} Here is the example how to build the base image: ```bash -bash scripts/build_base_image.sh -A atmlaml -P devel -V 3.10 -N test.sif +bash scripts/build_base_image.sh -A atmlaml -G atmlaml -P devel -V 3.10 -N test.sif ``` After running scripts/build_base_image.sh, a SLURM job will be launched, and a report will be generated in the `slurm_report` path. Please make sure to review this report to confirm that your image was created without any errors. The above command will create an singularity image in the following path: -`/p/project1/{account}/{$USER}/apptainer/test.sif` +`/p/project1/{account}/$USER/apptainer/test.sif`