Edited description.md in abaqus example

CM2S · Feb 21, 2024 · dfd7f4b · dfd7f4b
1 parent 893a55d
commit dfd7f4b
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 14 deletions.
diff --git a/docs/source/abaqus_solver_fitting/description.md b/docs/source/abaqus_solver_fitting/description.md
@@ -44,9 +44,9 @@ objective:
 
     cases:
       'sample.inp':
-        job_name: Job-1
-        step_name: Step-1
-        instance_name: Part-1-1
+        job_name: Job-1 # optional field for this case
+        step_name: Step-1 # optional field for this case
+        instance_name: Part-1-1 # optional field for this case
         fields:
           'reaction_x':
             name: FieldsOutput
@@ -62,6 +62,8 @@ objective:
 ```
 The field `abaqus_path` must indicate the path to the `Abaqus` executable. The input data file for running `Abaqus` is given in `examples/abaqus_solver_fitting/sample.inp`, where the notation `<Young>`, `<S1>` and `<S2>` indicates the parameters to optimise. For each function call, and before running the solver, these template parameters are substituted by their appropriate values in the `Abaqus` input data file.
 
+Note that the `Abaqus` input file (`sample.inp`) only has one Job, Step and Instance, so, the fields `job_name`, `step_name` and `instance_name` are optional in the `config.yaml`.
+
 To run this example, open a terminal inside the `piglot` repository, enter the `examples/abaqus_solver_fitting` directory and run piglot with the given configuration file
 ```bash
 cd examples/abaqus_solver_fitting
@@ -148,9 +150,9 @@ objective:
 
     cases:
       'sample.inp':
-        job_name: Job-1
-        step_name: Step-1
-        instance_name: Part-1-1
+        job_name: Job-1 # optional field for this case
+        step_name: Step-1 # optional field for this case
+        instance_name: Part-1-1 # optional field for this case
         fields:
           'reaction_x':
             name: FieldsOutput
@@ -165,7 +167,7 @@ objective:
       loss: nmse
 ```
 
-The output is the following:
+The output is the following
 ```
 BoTorch: 100%|███████████████████████████████████████| 20/20 [05:14<00:00, 15.70s/it, Loss: 8.2904e-08]
 Completed 20 iterations in 5m14s
@@ -176,7 +178,7 @@ Best parameters
 -    S2:   608.508550 
 ```
 
-The animation for all the function evaluations that have been made throughout the optimisation procedure are once again showed using the:
+The animation for all the function evaluations that have been made throughout the optimisation procedure are once again showed running
 ```bash
 piglot-plot animation config_composite.yaml
 ```

diff --git a/examples/abaqus_solver_fitting/config.yaml b/examples/abaqus_solver_fitting/config.yaml
@@ -25,9 +25,9 @@ objective:
 
     cases:
       'sample.inp':
-        job_name: Job-1
-        step_name: Step-1
-        instance_name: Part-1-1
+        job_name: Job-1 # optional field for this case
+        step_name: Step-1 # optional field for this case
+        instance_name: Part-1-1 # optional field for this case
         fields:
           'reaction_x':
             name: FieldsOutput

diff --git a/examples/abaqus_solver_fitting/config_composite.yaml b/examples/abaqus_solver_fitting/config_composite.yaml
@@ -26,9 +26,9 @@ objective:
 
     cases:
       'sample.inp':
-        job_name: Job-1
-        step_name: Step-1
-        instance_name: Part-1-1
+        job_name: Job-1 # optional field for this case
+        step_name: Step-1 # optional field for this case
+        instance_name: Part-1-1 # optional field for this case
         fields:
           'reaction_x':
             name: FieldsOutput