]> SALOME platform Git repositories - tools/ydefx.git/commitdiff
Salome HOME
Add examples to README.
authorOvidiu Mircescu <ovidiu.mircescu@edf.fr>
Fri, 6 Jan 2023 15:28:55 +0000 (16:28 +0100)
committerOvidiu Mircescu <ovidiu.mircescu@edf.fr>
Fri, 6 Jan 2023 15:28:55 +0000 (16:28 +0100)
README.md

index 758a5f17b636248b1058e27e3732ecb422ccad06..d9b12befa103e66df84baf835fb7a862e72318f3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,13 @@
-The goal of the ydefx library is a tool to make parametric computations on
-distributed resources. It can launch the computations on a remote cluster using
-a batch manager.
+# YDEFX
+Ydefx library is a tool to make parametric computations on distributed
+resources. It can launch the computations on a remote cluster using a batch
+manager.
 
 This library uses the Salome modules KERNEL and YACS.
+
+## Examples
+
+[Example of use explained in french.](src/pyexample/exemple_fr.py)
+[Minimalistic example.](src/pyexample/tests1.py)
+[Example using a different job for each evaluation.](src/pyexample/multijob/launch_multi.py)
+[Example using srun instead of YACS for distribution.](src/pyexample/multijob/launch_srun.py)