Ascent Actions Overview¶
Actions are the mechanism that instruct Ascent to perform operations. The currently supported actions are:
add_scenes
: adds a list of scenes to create imagesadd_extracts
: adds a list of extracts to move data out of Ascentadd_pipelines
: adds a list of pipelines to transform mesh dataadd_queries
: adds a list of queries that evaluate expressionsadd_triggers
: adds a list of triggers that executes a set of actions based on a conditionsave_info
: saves ascent info result at the end of executionsave_session
: saves expression session info at the end of execution (see Save Session Action)open_log
: opens an assent logging stream and starts loggingflush_log
: flushes the current logging stream to the output fileclose_log
: closes the current logging stream which stops loggingset_log_threshold
: changes the threshold of messages recorded in the log fileset_echo_threshold
: changes the threshold of messages displayed in standard output
Ascent actions can be specified within the integration using Conduit Nodes and can be read in through a file.
Actions files can be defined in both yaml
or json
, and if you are human, we recommend using yaml
.
Each time Ascent executes a set of actions, it will check for a file in the current working directory called ascent_actions.yaml
or ascent_actions.json
.
If found, the current actions specified in code will be replaced with the contents of the yaml or json file.
Then default name of the ascent actions file can be specified in the ascent_options.yaml
or in the
ascent options inside the simulation integration.
Here is an example of an ascent actions yaml file:
-
action: "add_scenes"
scenes:
scene1:
plots:
plt1:
type: "pseudocolor"
field: "braid"
The save_info
action outputs the contents of the Ascent::info()
API call, which provides a comprehensive snapshot of the runtime environment, including version details, available filters, transforms, and the execution flow graph.
This is an invaluable tool for debugging and will output even if Ascent encounters an error.
The default filename for the output is out_ascent_info_{cycle_number:06d}.yaml
.
Here is an example of an ascent actions yaml file using save_info
:
-
action: "save_info"
filename: "info_output.yaml" #optional
A full example of actions files populated from Ascent’s test suite can be found in Ascent Actions Examples.