We will use the python api, as this this gives us the most flexibility.
The standard way to access your suites is to use sync_local() , i.e.
import ecflow ci = ecflow.Client("my_host",3141) # replace the host and port with your own. ci.sync_local() # download all the suites on the server print(ci.get_defs()) |
The code above will suffice for the vast majority of cases. However if you have several suites, and are only interested in a subset, then the method above is not the most optimal. This method will be lot quicker.
import ecflow ci = ecflow.Client("my_host",3141) # replace the host and port with your own. suites_of_interest = [ 's1', 's2' ] # These are the *only* suites that I am interested in ci.ch_register(False,suites_of_interest) # register interest in the suites ci._sync_local() # sync_local() will now ONLY return the suites s1,s2 print(ci.get_defs()) ci.ch_drop() # remember to remove our registration, otherwise it stays in the server |
Here is more full blown example, demonstrating the performance differences, in retrieving all the suites, and in retrieving suites, via registration.
#////////1/////////2/////////3/////////4/////////5/////////6/////////7/////////8 # Name : # Author : Avi # Revision : $Revision: #10 $ # # Copyright 2009-2019 ECMWF. # This software is licensed under the terms of the Apache Licence version 2.0 # which can be obtained at http://www.apache.org/licenses/LICENSE-2.0. # In applying this licence, ECMWF does not waive the privileges and immunities # granted to it by virtue of its status as an intergovernmental organisation # nor does it submit to any jurisdiction. #////////1/////////2/////////3/////////4/////////5/////////6/////////7/////////8 import time import argparse # for argument parsing from ecflow import Client, debug_build def timing_decorator(function_to_time): def scafold(*function_args): # function_args is a tuple, the second argument is the suite name start = time.time() function_return = function_to_time(*function_args) end = time.time() print('%s function took %0.3f ms for %s' % (function_to_time.func_name, (end-start)*1000.0, function_args[1])) return function_return return scafold @timing_decorator def sync_local(ci,suite_name): ci.sync_local() if __name__ == "__main__": DESC = """This test is use to show the performance of sync local on the given server It should show that it is quicker to register and then sync_local() as this limits the amount of data that needs to be down loaded from the server. Usage: TestSyncLocalPerf.py --host <hostname> --port <portname> """ PARSER = argparse.ArgumentParser(description=DESC, formatter_class=argparse.RawDescriptionHelpFormatter) PARSER.add_argument('--host', default="localhost", help="The name of the host machine, defaults to 'localhost'") PARSER.add_argument('--port', default="3141", help="The port on the host, defaults to 3141") ARGS = PARSER.parse_args() print(ARGS ) print("####################################################################") print("Test performance of sync local using " + Client().version() + " debug build(" + str(debug_build()) +")") print("####################################################################") CL = Client(ARGS.host, ARGS.port) sync_local(CL,"* All suites *") # timing for downloading *all* suites print("") suites = CL.get_defs().suites for suite in suites: CL.ch_register(False,[suite.name()]) # register interest in single suite, corresponding handle is attached to CL sync_local(CL,suite.name()) # timing to download a single suite CL.ch_drop() # drop the last registered handle on CL |