Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Retrieving the suite definition

  • To retrieve the suite definition in a form that is parse-able, type:


    Code Block
    ecflow_client --get


    This can be done in a python script:

    Code Block
    languagepy
    import ecflow
    try:
        ci = ecflow.Client()                              # create the client, will read ECF_HOST and ECF_PORT from environment
        ci.sync_local()                                   # get server definition, by syncsyncing with client defs
        ecflow.PrintStyle.set_style( ecflow.Style.DEFS )  # set printing to show structure
        print(ci.get_defs())                              # print the returned suite definition
    except RuntimeError as e:
        print("Failed:",e)


  • To retrieve the suite definition and show state:


    Code Block
    languagebash
    ecflow_client --get_state   # show state, generated variables, expanded trigger expression, auto added externs
    ecflow_client --migrate     # shows state as comments, used as check point format


    In python this would be:

    Code Block
    languagepy
    import ecflow
    try:
        ci = ecflow.Client()
        ci.sync_local()                                     # retrieve server definition, by sync with client defs
        ecflow.PrintStyle.set_style( ecflow.Style.STATE )   # set printing to show structure and state, expanded trigger expression, generated variables   
        print(ci.get_defs())                                # print the returned suite definition
        ecflow.PrintStyle.set_style( ecflow.Style.MIGRATE ) # set printing to show structure and state, and node history
        print(ci.get_defs())                                # print the returned suite definition
    except RuntimeError as e:
        print("Failed:",  e)


     
  • To list just the node paths and states in python please see: How can I access the path and task states ?

What to do

  1. Locate the job file and the output file
  2. Check results by retrieving the suite definition from the server
     

...