Merge pull request festim-dev#871 from XinShen-CHN/Documentation--how…

…-to-run-FESTIM-in-parallel-#856 Documentation: how to run FESTIM in parallel festim-dev#856
JonathanGSDUFOUR · Sep 12, 2024 · a1e3aec · a1e3aec
2 parents 12628bd + d5ec17c
commit a1e3aec
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git 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
+   troubleshooting
+   running_in_parallel
diff --git a/docs/source/userguide/running_in_parallel.rst b/docs/source/userguide/running_in_parallel.rst
@@ -0,0 +1,9 @@
+============
+Running in parallel
+============
+
+FESTIM can be run in parallel on N cores using the command: 
+
+.. code::
+    
+    mpirun -np N python3 your_FESTIM_script.py