From 3e8a5cb473608ac5dac7e310980dae6794b4ebd0 Mon Sep 17 00:00:00 2001 From: Xinshen Date: Thu, 8 Aug 2024 21:28:59 +0800 Subject: [PATCH 1/7] Add the code for run FESTIM in parallel --- docs/source/userguide/beginners_guide.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/source/userguide/beginners_guide.rst b/docs/source/userguide/beginners_guide.rst index 03fc10a93..c2f8d0fb8 100644 --- a/docs/source/userguide/beginners_guide.rst +++ b/docs/source/userguide/beginners_guide.rst @@ -12,6 +12,12 @@ New users should familiarise themselves with `Conda `_. FESTIM is under version control with `git `_. Even though users don't need git to install FESTIM, it is convenient to understand how it works. You can find `git tutorials `_ to help you getting started. The `FESTIM source code `_ is hosted on GitHub. Signing up for free to GitHub is recommended to receive the latest updates, follow the development and submit `bug reports `_. +FESTIM can be run in parallel on N cores using the command: + +.. testcode:: + + mpirun -np N python3 your_FESTIM_script.py. + ---------------------- Where can I find help? ---------------------- From 36760210c3792d813b6fbee42c3124944472312c Mon Sep 17 00:00:00 2001 From: Xinshen Date: Fri, 9 Aug 2024 20:20:00 +0800 Subject: [PATCH 2/7] Replace testcode by code --- docs/source/userguide/beginners_guide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/userguide/beginners_guide.rst b/docs/source/userguide/beginners_guide.rst index c2f8d0fb8..65f0b6b23 100644 --- a/docs/source/userguide/beginners_guide.rst +++ b/docs/source/userguide/beginners_guide.rst @@ -14,7 +14,7 @@ FESTIM is under version control with `git `_. Even though FESTIM can be run in parallel on N cores using the command: -.. testcode:: +.. code:: mpirun -np N python3 your_FESTIM_script.py. From fd2c44ef6c4ddfc9b116b340edb30bbc724a602d Mon Sep 17 00:00:00 2001 From: Xinshen Date: Sat, 10 Aug 2024 15:27:52 +0800 Subject: [PATCH 3/7] Make a new page "Running in parallel" --- docs/source/userguide/Running in parallel | 5 +++++ docs/source/userguide/beginners_guide.rst | 6 ------ 2 files changed, 5 insertions(+), 6 deletions(-) create mode 100644 docs/source/userguide/Running in parallel diff --git a/docs/source/userguide/Running in parallel b/docs/source/userguide/Running in parallel new file mode 100644 index 000000000..a7696e9c1 --- /dev/null +++ b/docs/source/userguide/Running in parallel @@ -0,0 +1,5 @@ +FESTIM can be run in parallel on N cores using the command: + +.. code:: + + mpirun -np N python3 your_FESTIM_script.py. \ No newline at end of file diff --git a/docs/source/userguide/beginners_guide.rst b/docs/source/userguide/beginners_guide.rst index 65f0b6b23..03fc10a93 100644 --- a/docs/source/userguide/beginners_guide.rst +++ b/docs/source/userguide/beginners_guide.rst @@ -12,12 +12,6 @@ New users should familiarise themselves with `Conda `_. FESTIM is under version control with `git `_. Even though users don't need git to install FESTIM, it is convenient to understand how it works. You can find `git tutorials `_ to help you getting started. The `FESTIM source code `_ is hosted on GitHub. Signing up for free to GitHub is recommended to receive the latest updates, follow the development and submit `bug reports `_. -FESTIM can be run in parallel on N cores using the command: - -.. code:: - - mpirun -np N python3 your_FESTIM_script.py. - ---------------------- Where can I find help? ---------------------- From 08c6d8eb9e387e4c00b25fce3e946594ab396e10 Mon Sep 17 00:00:00 2001 From: XinShen-CHN Date: Sun, 8 Sep 2024 16:20:41 +0800 Subject: [PATCH 4/7] Rename the new file --- docs/source/userguide/index.rst | 3 ++- .../userguide/{Running in parallel => running_in_parallel.rst} | 0 2 files changed, 2 insertions(+), 1 deletion(-) rename docs/source/userguide/{Running in parallel => running_in_parallel.rst} (100%) diff --git a/docs/source/userguide/index.rst b/docs/source/userguide/index.rst index 3ba23a73c..f22674185 100644 --- a/docs/source/userguide/index.rst +++ b/docs/source/userguide/index.rst @@ -18,4 +18,5 @@ User's Guide stepsize newton_solver export_post_processing - troubleshooting \ No newline at end of file + troubleshooting + running_in_parallel \ No newline at end of file diff --git a/docs/source/userguide/Running in parallel b/docs/source/userguide/running_in_parallel.rst similarity index 100% rename from docs/source/userguide/Running in parallel rename to docs/source/userguide/running_in_parallel.rst From 6b6d42c9f80783a711f482dd8d48eafaf4ae062f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Delaporte-Mathurin?= <40028739+RemDelaporteMathurin@users.noreply.github.com> Date: Mon, 9 Sep 2024 08:26:52 -0400 Subject: [PATCH 5/7] add title --- docs/source/userguide/running_in_parallel.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/source/userguide/running_in_parallel.rst b/docs/source/userguide/running_in_parallel.rst index a7696e9c1..5944054ed 100644 --- a/docs/source/userguide/running_in_parallel.rst +++ b/docs/source/userguide/running_in_parallel.rst @@ -1,3 +1,5 @@ +# Running in parallel + FESTIM can be run in parallel on N cores using the command: .. code:: From 01844578416d17b59e186f093ea82848382896f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Delaporte-Mathurin?= <40028739+RemDelaporteMathurin@users.noreply.github.com> Date: Mon, 9 Sep 2024 11:41:44 -0400 Subject: [PATCH 6/7] correct syntax --- docs/source/userguide/running_in_parallel.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/source/userguide/running_in_parallel.rst b/docs/source/userguide/running_in_parallel.rst index 5944054ed..24f7152b7 100644 --- a/docs/source/userguide/running_in_parallel.rst +++ b/docs/source/userguide/running_in_parallel.rst @@ -1,4 +1,6 @@ -# Running in parallel +============ +Running in parallel +============ FESTIM can be run in parallel on N cores using the command: From d5ec17c98a9e02f0957061346b08b68398f3f37e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Delaporte-Mathurin?= <40028739+RemDelaporteMathurin@users.noreply.github.com> Date: Mon, 9 Sep 2024 16:32:05 -0400 Subject: [PATCH 7/7] removed the dot --- docs/source/userguide/running_in_parallel.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/userguide/running_in_parallel.rst b/docs/source/userguide/running_in_parallel.rst index 24f7152b7..e53d89597 100644 --- a/docs/source/userguide/running_in_parallel.rst +++ b/docs/source/userguide/running_in_parallel.rst @@ -6,4 +6,4 @@ FESTIM can be run in parallel on N cores using the command: .. code:: - mpirun -np N python3 your_FESTIM_script.py. \ No newline at end of file + mpirun -np N python3 your_FESTIM_script.py \ No newline at end of file