pydefx 9.14.0__py3-none-any.whl

pydefx/schemas/plugin.py

@@ -0,0 +1,81 @@
+from salome.yacs import SALOMERuntime
+import pickle
+import json
+import importlib
+
+class myalgosync(SALOMERuntime.OptimizerAlgSync):
+  def __init__(self):
+    SALOMERuntime.OptimizerAlgSync.__init__(self, None)
+    self.started = False
+
+  def setPool(self,pool):
+    """Must be implemented to set the pool"""
+    self.pool=pool
+
+  def getTCForIn(self):
+    """return typecode of type expected as Input of the internal node """
+    return SALOMERuntime.getSALOMERuntime().getTypeCode("string")
+
+  def getTCForOut(self):
+    """return typecode of type expected as Output of the internal node"""
+    return SALOMERuntime.getSALOMERuntime().getTypeCode("string")
+
+  def getTCForAlgoInit(self):
+    """return typecode of type expected as input for initialize """
+    return SALOMERuntime.getSALOMERuntime().getTypeCode("string")
+
+  def getTCForAlgoResult(self):
+    """return typecode of type expected as output of the algorithm """
+    return SALOMERuntime.getSALOMERuntime().getTypeCode("int")
+
+  def initialize(self,input):
+    """Optional method called on initialization.
+       The type of "input" is returned by "getTCForAlgoInit"
+    """
+    with open("idefixconfig.json", "r") as f:
+      self.config = json.load(f)
+
+  def start(self):
+    """Start to fill the pool with samples to evaluate."""
+    itModuleName = self.config["sampleIterator"]
+    itModule = importlib.import_module(itModuleName)
+    self.started = True
+    self.manager = itModule.SampleIterator()
+    self.manager.writeHeaders()
+    values=None
+    for i in range(0, self.getNbOfBranches()):
+      try:
+        newid, values = next(self.manager)
+        self.pool.pushInSample(newid, pickle.dumps(values, protocol=0).decode())
+      except StopIteration:
+        pass
+
+  def takeDecision(self):
+    """ This method is called each time a sample has been evaluated. It can
+        either add new samples to evaluate in the pool, do nothing (wait for
+        more samples), or empty the pool to finish the evaluation.
+    """
+    currentId=self.pool.getCurrentId()
+    samplebyte=self.pool.getCurrentInSample().getStringValue().encode()
+    sample = pickle.loads(samplebyte)
+    resultbyte=self.pool.getCurrentOutSample().getStringValue().encode()
+    error,result = pickle.loads(resultbyte)
+    self.manager.addResult(currentId, sample, result, error)
+    try:
+      newid, values = next(self.manager)
+      self.pool.pushInSample(newid, pickle.dumps(values, protocol=0).decode())
+    except StopIteration:
+      pass
+
+  def finish(self):
+    """Optional method called when the algorithm has finished, successfully
+       or not, to perform any necessary clean up."""
+    if self.started :
+      self.manager.terminate()
+      self.pool.destroyAll()
+
+  def getAlgoResult(self):
+    """return the result of the algorithm.
+       The object returned is of type indicated by getTCForAlgoResult.
+    """
+    return 0

pydefx/slurmbuilder.py

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2019-2024 EDF
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+import inspect
+import pathlib
+import os
+from .allpurposebuilder import AllPurposeBuilder
+
+class SlurmBuilder(AllPurposeBuilder):
+  def __init__(self, executor = None, pointEval = None, mainJob = None):
+    filename = inspect.getframeinfo(inspect.currentframe()).filename
+    install_root_directory = pathlib.Path(filename).resolve().parent
+    install_files_directory = os.path.join(install_root_directory, "plugins")
+
+    if executor is None:
+      executor = os.path.join(install_files_directory, "srunexecutor.py")
+    super().__init__(executor, pointEval, mainJob)

pydefx/slurmstudy.py

@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2019-2024 EDF
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+import copy
+import os
+import json
+from . import pystudy
+from . import slurmbuilder
+from . import salome_proxy
+from . import configuration
+
+class SlurmStudy(pystudy.PyStudy):
+  def __init__(self, sampleManager=None, schemaBuilder=None):
+    if schemaBuilder is None:
+      schemaBuilder = slurmbuilder.SlurmBuilder()
+    super().__init__(sampleManager, schemaBuilder)
+
+  def createNewJob(self, script, sample, params):
+    # TODO: modifier le copier/coller
+    self._check(script,sample)
+    self.sample = sample
+    self.params = copy.deepcopy(params)
+    main_job_work_dir = self.params.salome_parameters.result_directory
+    if not os.path.exists(main_job_work_dir):
+      os.makedirs(main_job_work_dir)
+    # set the parameters of the local job
+    self.params.salome_parameters.job_type = self.jobType()
+
+    result_directory = self.params.salome_parameters.result_directory
+    # export sample to result_directory
+    inputFiles = self.sampleManager.prepareRun(self.sample, result_directory)
+    inputFiles.extend([self.schemaBuilder.getExecutor(),
+                       self.schemaBuilder.getPointEval()])
+    self.params.salome_parameters.job_file = self.schemaBuilder.getMainJob()
+
+    # export config
+    dicconfig = {}
+    dicconfig["nbbranches"]  = self.params.nb_branches
+    dicconfig["studymodule"] = "idefixstudy"
+    dicconfig["sampleIterator"] = self.sampleManager.getModuleName()
+    dicconfig["plugin"] = self.schemaBuilder.getPluginName()
+    nbproc = self.params.salome_parameters.resource_required.nb_proc
+    dicconfig["tasksPerEval"] = nbproc // self.params.nb_branches
+    configpath = configuration.exportConfig(dicconfig, result_directory)
+    studypath = os.path.join(result_directory, "idefixstudy.py")
+    with open(studypath, "w") as f:
+      f.write(script.script)
+
+    inputFiles.extend([configpath, studypath])
+
+    # this list manipulation is needed because in_files is not a python list
+    # if we don't use a salome session. In that case swig uses a python tuple
+    # in order to map a std::list as a parameter of a structure.
+    in_files_as_list = list(self.params.salome_parameters.in_files)
+    self.params.salome_parameters.in_files = in_files_as_list + inputFiles
+    launcher = salome_proxy.getLauncher()
+    self.job_id = launcher.createJob(self.params.salome_parameters)
+    return self.job_id
+
+  def jobType(self):
+    return "command_salome"

pydefx/studyexception.py

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2019-2024 EDF
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+class StudyException(Exception):
+  """
+  Root of exceptions raised by a study.
+  """
+  def __init__(self, message):
+    super().__init__(message)
+
+class StudyUseException(StudyException):
+  """
+  Exception used when there is a bad utilisation of the study - functions called
+  in a wrong order.
+  """
+  def __init__(self, message):
+    super().__init__(message)
+
+class StudyRunException(StudyException):
+  """
+  Exception used when there is a problem when running the study.
+  """
+  def __init__(self, message):
+    super().__init__(message)

pydefx/studyresult.py

@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2019-2024 EDF
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+class StudyResult:
+  """
+  This class gathers global information about the execution of the study (global
+  errors, global result).
+  """
+  def __init__(self):
+    self.result = None
+    self.exit_code = None
+    self.error_message = None
+
+  def isExitCodeAvailable(self):
+    return not self.exit_code is None
+
+  def getExitCode(self):
+    return self.exit_code
+
+  def isResultAvailable(self):
+    return not self.exit_code is None
+
+  def getResult(self):
+    return self.result
+
+  def hasErrors(self):
+    return not self.error_message is None and len(self.error_message) > 0
+
+  def getErrors(self):
+    return self.error_message
+
+  def __str__(self):
+    result = """Exit code : {}
+Error message : {}
+Result:
+{}""".format(self.exit_code, self.error_message, self.result)
+    return result

pydefx-9.14.0.dist-info/METADATA

@@ -0,0 +1,22 @@
+Metadata-Version: 1.2
+Name: pydefx
+Version: 9.14.0
+Summary: tool for parametric computations of SALOME platform
+Home-page: https://github.com/SalomePlatform/ydefx
+Author: EDF R&D
+Author-email: eric.fayolle@edf.fr
+License: LGPL
+Keywords: salome
+Platform: any
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
+Classifier: Programming Language :: C++
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Intended Audience :: Science/Research
+Requires-Dist: salome.yacs
+
+pydefx
+======
+
+Ydefx library is a tool to make parametric computations on distributed resources.

pydefx-9.14.0.dist-info/RECORD

@@ -0,0 +1,45 @@
+./mpmcn.py,sha256=gv8Tl8oSBsUhH2EuqPGDlaegxtk_rUyizvysmAt3sQ8=,6649
+./salome/bin/salome/test/CTestTestfile.cmake,sha256=Kg2sTm7DL9mWjhYDrPz3UXjBG1Jcn9bjQGqAkD47PiA=,1022
+./salome/bin/salome/test/cpp/StudyGeneralTest,sha256=ZlXHlIVRMqVNFgGEFI9M_qEJp-Jbf0fzwQU2QqZRgfY=,216048
+./salome/bin/salome/test/cpp/SampleTest,sha256=I8fCA8klhOmWNStSvv2djHd0NImpr-LB_NQSA1GVo8g=,280496
+./salome/bin/salome/test/cpp/CTestTestfile.cmake,sha256=JjSkD4flyDAd4ENPkzPXvsgaVU1X9bfxgnWCdbGqFV4=,1492
+./salome/bin/salome/test/cpp/StudyRestartTest,sha256=rrvAMCz3rLtUbvhG8dxKcee1PJSxUHePYdySG0oZK8Y=,112976
+./salome/bin/salome/test/pyexample/test_ydefx_base.py,sha256=BXl-Zsu6YoMfZBZUYSY2xDPJq3SnAapDyKLWWQO3CuY=,3548
+./salome/bin/salome/test/pyexample/test_default.py,sha256=CpDNuLT2BEL8pzjXDUnVb6zJzehu7FIp8WCGxSs56lg=,2114
+./salome/bin/salome/test/pyexample/CTestTestfile.cmake,sha256=hsdRpK-RznugDLCDWYm3ga_j7Z6w26PLTU5cd-Rze_0=,1078
+./salome/bin/salome/test/pyexample/runUnitTest.sh,sha256=0szCXwZm5zXMhzvZ6ac-Sfv9qH0BEjyiTsApXPPZRPw=,1010
+./salome/bin/salome/test/pyexample/test_prescript.py,sha256=d95SazPsqfCsygFQhE2hjDcPfiY_0amVgOpC31p29Lc=,1527
+./salome/bin/salome/test/pyexample/test_mpmcn.py,sha256=yMzcSfB2cec92MPI0vF_s1x7N_Ujwh1X3QOeOvltn0s=,1168
+./salome/bin/salome/test/pyexample/test_insitu.py,sha256=FI7xe_cCHotAwbHRWyorV-piW7qPG8KH60AqkWkaZqw=,1581
+./salome/bin/salome/test/pyexample/insitu/insituiterator.py,sha256=Ya7O4NAdP1TNMlCV3_VFbhXI4guKdhiJJj9-I3Df4y8=,1890
+./salome/bin/salome/test/pyexample/insitu/insitumanager.py,sha256=iLjGJxUOekyc-6cmYWVhMGqNHO4mdpQVrNBH8Fmn9Z0=,1844
+./pydefx/studyexception.py,sha256=sBnASgZxLNKG0PlAtycRqgGPYw6YSwN2FDwCh7l3SDw=,1407
+./pydefx/pyscript.py,sha256=B9W699pfHSVrBvwXNV3Hg5ulBcaE_F1cEaAlB6fT60o=,3895
+./pydefx/localbuilder.py,sha256=YpRU6G8_xreNWClJo1CPdTt2k-ptFgV9uI1DopUILqk=,1728
+./pydefx/multijobbuilder.py,sha256=xN5cBTlTJelXqD-5NGUtPNo6gPT6r70hVsKN6zrxKBE=,1435
+./pydefx/sample.py,sha256=sdRnnSjNFNaG2c9lF89EXOVIpygtn7rNRZx5N_u-kMA=,8201
+./pydefx/samplecsviterator.py,sha256=OSrpK9pmFAYh_nN10KfNfSmlmw_LR1ZymKcJKE-w8hg=,7323
+./pydefx/defaultschemabuilder.py,sha256=fXApmYOAxiI0Esb1CpQ67kfv48YtSWa4MrZADnZlWjM=,2204
+./pydefx/multijobstudy.py,sha256=BbZC-Wj-YR-86L3AZTHeVcDaAtji26XmlQ8vCTZEikk=,3583
+./pydefx/allpurposebuilder.py,sha256=yKHHeukvZj35iV3tVLesfBEwumc-r4-1jNM4DqHlIL4=,2030
+./pydefx/slurmstudy.py,sha256=i8qg89__V7g3YCr2gMg4ccQjeEl6bNbpsCMRtzS2wZU=,3257
+./pydefx/salome_proxy.py,sha256=F3IPIzr39wTig-_A6eaFoFN-BNEETpX368GzoGeRweg=,2484
+./pydefx/parameters.py,sha256=OxJMnO5TodrWv_RYHp_kK6ATmUc3bwX0XqlK4JG0deQ=,10542
+./pydefx/slurmbuilder.py,sha256=KNVAU6KRYt58qBM4drXwTbH0TreFcsBWPD87XRTnYoE=,1433
+./pydefx/configuration.py,sha256=yxo18DwSbj3xD_jhgmw1OrVARfdPIkUbTabw_I0Amuc=,4489
+./pydefx/localstudy.py,sha256=31h1SSFl7tUS6TjAy58RQggiKaaTSE4cg0nJbGpQ0BE=,3260
+./pydefx/pystudy.py,sha256=hk6d5ONBn1hStYIOba7zmrc9xYvszNLJZITt3dj5D2c=,12680
+./pydefx/studyresult.py,sha256=Zry29oVglnhNX_zYM4hDnIbXPiGcnWPw-8WbNY8JSCo=,1657
+./pydefx/samplecsvmanager.py,sha256=RItHOCQc72O6fv-siSNF1f9iPi5eU3oqyzHGplRQroE=,5531
+./pydefx/__init__.py,sha256=b6X6ep9xIcL55miqh5VSPaiA3MCfjsD7ZfcJ_yEucFU=,1367
+./pydefx/plugins/mainjob.py,sha256=qAKBgLACvFefvwkP8C_ntiNBbvlj9-T1sSVqr2cQxao=,1584
+./pydefx/plugins/pointeval.py,sha256=irnGedatMCIVZTFlhYG3rvwqrPrJo5uZVPpvC48vEmI=,937
+./pydefx/plugins/localexecutor.py,sha256=UwSPKHGHbLJIbvUyTYp0XLwxoFuq9-lkrbSCtLRuf5w=,2338
+./pydefx/plugins/lightexecutor.py,sha256=75Hmd_QVL1ndBkcxEOQWpb68MmuNS0TZvvAU0hEmxuk=,953
+./pydefx/plugins/jobexecutor.py,sha256=BQGk-xV3ruuCj5T8cKb1AOAvfsPRMMee2RFAcTVdwn0=,4610
+./pydefx/plugins/srunexecutor.py,sha256=FjOyRauhQeK30Yfa59D9F5OgoQdjVz-a4-1WXRzupMY=,2603
+./pydefx/schemas/plugin.py,sha256=S5TI2EvYtOhEPIAJp3KN1L5ySD6rBvPHJaxmLW_bBAE=,2882
+./pydefx/schemas/idefix_pyschema.xml,sha256=0jE6Ml6ieEyB-4Gm1FWkujohgrdUvY2kBdyqRiPflUs=,4393
+./pydefx-9.14.0.dist-info/METADATA,sha256=w2cJaLYCNx-ofb7ml50cGY8NvsSOAuAdDdwOGPnlBGU=,727
+./pydefx-9.14.0.dist-info/WHEEL,sha256=toYQVYYf5C9LeESCm2UcHbMMqDwSAVkkAchMdEqcWys=,78
+./pydefx-9.14.0.dist-info/RECORD,,

pydefx-9.14.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: custom
+Root-Is-Purelib: true
+Tag: py3-none-any

salome/bin/salome/test/CTestTestfile.cmake

@@ -0,0 +1,28 @@
+# Copyright (C) 2019-2024  EDF
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+SET(SALOME_TEST_DRIVER "$ENV{KERNEL_ROOT_DIR}/bin/salome/appliskel/salome_test_driver.py")
+
+SET(COMPONENT_NAME YDEFX)
+SET(TIMEOUT        500)
+
+SUBDIRS(
+    cpp
+    pyexample
+    )

salome/bin/salome/test/cpp/CTestTestfile.cmake

@@ -0,0 +1,36 @@
+# Copyright (C) 2019-2024  EDF
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+SET(TEST_NAME ${COMPONENT_NAME}_SampleTest)
+ADD_TEST(${TEST_NAME} ./SampleTest)
+SET_TESTS_PROPERTIES(${TEST_NAME} PROPERTIES
+                                  LABELS "${COMPONENT_NAME}"
+                    )
+
+SET(TEST_NAME ${COMPONENT_NAME}_StudyGeneralTest)
+ADD_TEST(${TEST_NAME} ./StudyGeneralTest)
+SET_TESTS_PROPERTIES(${TEST_NAME} PROPERTIES
+                                  LABELS "${COMPONENT_NAME}"
+                    )
+
+SET(TEST_NAME ${COMPONENT_NAME}_StudyRestartTest)
+ADD_TEST(${TEST_NAME} ./StudyRestartTest)
+SET_TESTS_PROPERTIES(${TEST_NAME} PROPERTIES
+                                  LABELS "${COMPONENT_NAME}"
+                    )

salome/bin/salome/test/pyexample/CTestTestfile.cmake

@@ -0,0 +1,25 @@
+# Copyright (C) 2019-2024  EDF
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+SET(TEST_NAME ${COMPONENT_NAME}_PyExampleTest)
+ADD_TEST(${TEST_NAME} ./runUnitTest.sh)
+SET_TESTS_PROPERTIES(${TEST_NAME} PROPERTIES
+                                  LABELS "${COMPONENT_NAME}"
+                    )
+                    

salome/bin/salome/test/pyexample/insitu/insituiterator.py

@@ -0,0 +1,48 @@
+# Copyright (C) 2019-2024 EDF
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+# The following import is made in the execution environment and in the working
+# directory of the job.
+import samplecsviterator
+import os
+
+class SampleIterator(samplecsviterator.SampleIterator):
+  """
+  Example of an iterator which uses insitu computation.
+  """
+  def __init__(self, directory=None):
+    super().__init__(directory)
+    self.insitu_result = 0
+
+  def addResult(self, currentId, currentInput, currentOutput, currentError):
+    """
+    currentId    : integer. Index of the curent point.
+    currentInput : dictionary of curent input values (name, value)
+    currentOutput: tuple with the output values
+    currentError : string. Empty if no error.
+    """
+    super().addResult(currentId, currentInput, currentOutput, currentError)
+    value_of_interest = currentOutput
+    self.insitu_result = self.insitu_result + value_of_interest
+
+  def terminate(self):
+    super().terminate()
+    result_file = os.path.join(self.result_directory, "insitu_result.txt")
+    with open(result_file, "w") as f:
+      f.write(repr(self.insitu_result))

salome/bin/salome/test/pyexample/insitu/insitumanager.py

@@ -0,0 +1,46 @@
+# Copyright (C) 2019-2024 EDF
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+import pydefx.samplecsvmanager
+import inspect
+import os
+import pathlib
+
+class InsituManager(pydefx.samplecsvmanager.SampleManager):
+  def prepareRun(self, sample, directory):
+    files_list = super().prepareRun(sample, directory)
+    # add the insituiterator file to the list
+    filename = inspect.getframeinfo(inspect.currentframe()).filename
+    install_directory = pathlib.Path(filename).resolve().parent
+    iteratorFile = os.path.join(install_directory, "insituiterator.py")
+    files_list.append(iteratorFile)
+    return files_list
+
+  def loadResult(self, sample, directory):
+    super().loadResult(sample, directory)
+    # load the insitu result and return it
+    insitu_result_file = os.path.join(directory,
+                                      self.getResultFileName(),
+                                      "insitu_result.txt")
+    with open(insitu_result_file, "r") as f:
+      result_string = f.read()
+    return eval(result_string)
+
+  def getModuleName(self):
+    return "insituiterator"

salome/bin/salome/test/pyexample/runUnitTest.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+# Copyright (C) 2019-2024  EDF
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+python3 -m unittest test_insitu.py test_prescript.py test_default.py test_ydefx_base.py
+ret0=$?
+python3 test_mpmcn.py
+ret1=$?
+let ret=$ret0+$ret1
+exit $ret

salome/bin/salome/test/pyexample/test_default.py

@@ -0,0 +1,79 @@
+import unittest
+import os
+import time
+
+class TestYdefx(unittest.TestCase):
+  def test_errors(self):
+    """
+    Test errors in study script.
+    """
+    import pydefx
+
+    myScript = pydefx.PyScript()
+    myScript.loadString("a=5")
+    self.assertIn("not accepted statement", myScript.getErrors())
+    
+    myScript.loadString("n'importe quoi!")
+    self.assertIn("SyntaxError", myScript.getErrors())
+
+    myScript.loadString("")
+    self.assertIn("Function _exec not found", myScript.getErrors())
+    
+    with self.assertRaises(pydefx.pyscript.PyScriptException):
+      mySample = myScript.CreateEmptySample()
+
+  def test_availableResources(self):
+    import pydefx
+    lr = pydefx.configuration.availableResources()
+    self.assertIn('localhost', lr)
+
+  def test_invalid_study(self):
+    import pydefx
+    myParams = pydefx.Parameters()
+    myParams.configureResource("localhost")
+    myScript = pydefx.PyScript()
+    myStudy = pydefx.PyStudy()
+
+    myScript.loadString("wrong 'script")
+    mySample = pydefx.Sample([],[])
+    try:
+      myStudy.createNewJob(myScript, mySample, myParams)
+      self.fail("Excpected pydefx.pyscript.PyScriptException!")
+    except pydefx.pyscript.PyScriptException:
+      pass
+    except pydefx.studyexception.StudyException:
+      pass
+
+    script="""
+def _exec():
+  x=5
+  return x
+"""
+    myScript.loadString(script)
+    try:
+      myStudy.createNewJob(myScript, mySample, myParams)
+      self.fail("Excpected pydefx.studyexception.StudyUseException!")
+    except pydefx.studyexception.StudyException:
+      pass
+
+    script="""
+def _exec(a):
+  x=5
+  return x
+"""
+    myScript.loadString(script)
+    try:
+      myStudy.createNewJob(myScript, mySample, myParams)
+      self.fail("Excpected pydefx.studyexception.StudyUseException!")
+    except pydefx.studyexception.StudyException:
+      pass
+
+    mySample = pydefx.Sample(["b"],[])
+    try:
+      myStudy.createNewJob(myScript, mySample, myParams)
+      self.fail("Excpected pydefx.studyexception.StudyUseException!")
+    except pydefx.studyexception.StudyException:
+      pass
+
+if __name__ == '__main__':
+    unittest.main()