- document new flags

copasi · Feb 16, 2023 · a9e1af8 · a9e1af8
1 parent 89e362e
commit a9e1af8
Showing 1 changed file with 14 additions and 2 deletions.
diff --git a/basico/task_parameterestimation.py b/basico/task_parameterestimation.py
@@ -1628,12 +1628,18 @@ def get_experiment_dict(experiment, **kwargs):
     - | `model`: to specify the data model to be used (if not specified
       | the one from :func:`.get_current_model` will be taken)
 
+    - | `raise_error`: boolean indicating that an error should be raised if the
+      |  experimentfile is not present (default: False)
+
+    - | `return_relative`: to indicate that relative experiment filenames should
+      | be returned (default: True)
+
     :return: all information about the experiment as dictionary
     """
     experiment = get_experiment(experiment, **kwargs)
 
-    kwargs['raise_error'] = False
-    kwargs['return_relative'] = True
+    kwargs['raise_error'] = kwargs.get('raise_error', False)
+    kwargs['return_relative'] = kwargs.get('return_relative', True)
     filename = _get_experiment_file(experiment, **kwargs)
 
     result = {
@@ -1681,6 +1687,12 @@ def save_experiments_to_dict(**kwargs):
     - | `model`: to specify the data model to be used (if not specified
       | the one from :func:`.get_current_model` will be taken)
 
+    - | `raise_error`: boolean indicating that an error should be raised if the
+      |  experimentfile is not present (default: False)
+
+    - | `return_relative`: to indicate that relative experiment filenames should
+      | be returned (default: True)
+
     :return: the parameter estimation experimetns as list of dictionary
     :rtype: [{}]
     """