Default simulation setup #157

Activity

1. benbovy

   changed the title [-]Add default clocks and output variables to a Model object[/-] [+]Default simulation setup[/+] on Nov 23, 2020
2. benbovy commented on Nov 23, 2020

   

   benbovy

   on Nov 23, 2020

   MemberAuthor

   More actions

   xsimlab.Model could provide a default_setup argument that accepts a dictionary with the exact same structure than the xsimlab.create_setup arguments (i.e., clocks, input_vars, output_vars).

   If default_setup is provided, then xsimlab.create_setup is called at model creation and the resulting dataset is attached to the new Model object. This dataset could be accessible, e.g., with the Model.default_setup property.

   Pros:

   This would allow something like:

   with model:
       out_ds = (
           model.default_setup
           .xsimlab.update_vars(input_vars={...})
           .xsimlab.run()
       )

   Cons:

   Default setup would likely break when creating new models with update_processes or drop_processes. It would be tricky to propagate the default setup.