Documentation is under construction. Please use examples as the main reference.

analysis#

Listing 1 Overview#
1analysis:
2  steps:
3    - step: "step 1"
4      type: "cs"
5      ...
6    - step: "step 2"
7      ...

steps#

Specification of analysis steps.

  • Required (at least one step)

  • Type: List

  • Default: None

step#

Name of the current step.

  • Required

  • Type: String

type#

Type of the current analysis step.

  • Required

  • Type: String

  • Arguments: cs|script

cs defines a cross-sectional analysis step. script defines a custom step using user-provided Python scripts.

Related pages

analysis#

Use under:

analysis:
  steps:
    - step: "..."
      type: "cs"
      analysis: "..."

Specify the cross-sectional analysis type.

  • Required

  • Type: String

  • Arguments: h|fi

file#

Use under:

analysis:
  steps:
    - step: "..."
      type: "script"
      file: "..."

Name of the custom Python script file.

  • Required

  • Type: String

Related pages

function#

Use under:

analysis:
  steps:
    - step: "..."
      type: "script"
      function: "..."

Name of the custom Python function.

  • Required

  • Type: String

Related pages

args#

Use under:

analysis:
  steps:
    - step: "..."
      type: "script"
      args:
        - arg1
        - arg2
        - ...

Extra positional arguments passed to the custom Python function.

  • Optional

  • Type: List

Related pages

kwargs#

Use under:

analysis:
  steps:
    - step: "..."
      type: "script"
      kwargs:
        kw1: arg1
        kw2: arg2
        ...

Extra keyword arguments passed to the custom Python function.

  • Optional

  • Type: Dictionary

Related pages

Listing 2 Example#
 1analysis:
 2  steps:
 3    - step: "cs analysis"
 4      type: 'cs'
 5      analysis: 'h'
 6    - step: "calc diff"
 7      type: "script"
 8      file: 'data_proc_funcs'
 9      function: "dakota_postpro"
10      kwargs:
11        beam_properties: ["gj", "ei22", "ei33"]
12        target: [2.29e3, 3.98e3, 2.44e5]