Custom run names

Setting custom names for runs can be useful when dealling with many simulations. For example, you can encode a range of attributes in the run name like {{x}}/{{y}}/{{z}} where x,y and z are all parameter values.

This is now supported in Veneer + veneer-py. You may need to update your Veneer plugin.



In [12]:

    
import veneer
v = veneer.Veneer()



In [13]:

    
help(v.run_model)









    



Help on method run_model in module veneer.general:

run_model(params=None, start=None, end=None, async=False, name=None, **kwargs) method of veneer.general.Veneer instance
    Trigger a run of the Source model
    
    params: Python dictionary of parameters to pass to Source. Should match the parameters expected
            of the running configuration. (If you just want to set the start and end date of the simulation,
            use the start and end parameters
    
    start, end: The start and end date of the simulation. Should be provided as Date objects or as text in the dd/mm/yyyy format
    
    async: (default False). If True, the method will return immediately rather than waiting for the simulation to finish.
           Useful for triggering parallel runs. Method will return a connection object that can then be queried to know
           when the run has finished.
    
    name: Name to assign to run in Source results (default None: let Source name using default strategy)
    
    kwargs: optional named parameters to be used to update the params dictionary
    
    In the default behaviour (async=False), this method will return once the Source simulation has finished, and will return
    the URL of the results set in the Veneer service



In [14]:

    
v.run_model(name="Custom Run Name")









    Out[14]:





(302, 'runs/1')



In [15]:

    
v.retrieve_runs()









    Out[15]:





[{'RunName': 'Custom Run Name (1)', 'RunUrl': '/runs/1'}]



In [ ]: