diff --git a/README.rst b/README.rst index e60558d028990157bcec3f8996ba42eca4b6a78c..c181414db0f41b2bbc7f5c411a8bbfc87821af7f 100644 --- a/README.rst +++ b/README.rst @@ -80,7 +80,13 @@ Download or build the singularity container in the container directory Checking if frangiPANe has been correctly installed ----------------- -* Run the `frangiPANe` command, the following lines have to print if all i alright : +* You can run the following command : + +:: + + frangiPANe command + +If everything is okay, the following lines should be printed. :: @@ -135,7 +141,13 @@ Checking if frangiPANe has been correctly installed test_install Test frangiPANe cluster mode with "data_test" -* Run the command `frangiPANe edit_tools` to check the path of the container and modify the name of modules to load if necessary (cluster mode): +* To check the path of the container and modify the name of modules if necessary in cluster mode, run the following command: + +:: + + frangiPANe edit_tools + +This command should display information about the container path and allow you to make modifications to the module names if needed. :: @@ -220,7 +232,13 @@ III - Run FrangiPANe **cluster mode** -* Configure slurm jobs with the command `frangiPANe edit_cluster_config` +* To configure Slurm jobs, you can run the following command : + +:: + + frangiPANe edit_cluster_config + +This command is likely to open a configuration file in a text editor, allowing you to specify the necessary parameters for configuring Slurm jobs. Make the required modifications, save the file, and exit the text editor. :: @@ -249,7 +267,7 @@ III - Run FrangiPANe 23 24 #create_panref -* Launch your first analysis with frangiPANe. Start with data-test ! +* To launch your first analysis with frangiPANe using the data-test dataset : ::