From c88c5240b3388198f838dd553cc8d06223f0e35a Mon Sep 17 00:00:00 2001 From: Timothy Willard <9395586+TimothyWillard@users.noreply.github.com> Date: Wed, 11 Dec 2024 15:39:05 -0500 Subject: [PATCH] `flepimop patch` documenation edits Stronger and clearer wording suggested by @saraloo. --- documentation/gitbook/how-to-run/multi-configs.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/documentation/gitbook/how-to-run/multi-configs.md b/documentation/gitbook/how-to-run/multi-configs.md index 27e65b324..54402c3b5 100644 --- a/documentation/gitbook/how-to-run/multi-configs.md +++ b/documentation/gitbook/how-to-run/multi-configs.md @@ -20,19 +20,19 @@ You should see an assortment of yml files as a result of that `ls` command. ## Usage -If you run +If you run: ```bash flepimop simulate config_sample_2pop.yml ``` -you'll get a basic foward simulation of this example model. However, you might also note there are several `*_part.yml` files, corresponding to partial configs. You can `simulate` using the combination of multiple configs with, for example: +You'll get a basic forward simulation of this example model. However, you might also note there are several `*_part.yml` files, corresponding to partial configs. You can `simulate` using the combination of multiple configs with, for example: ```bash flepimop simulate config_sample_2pop.yml config_sample_2pop_outcomes_part.yml ``` -if want to create a combined configuration (e.g. to check what the combined configuration is), you can use the `patch` command: +While simulate can run your patched configuration, we also suggest you check your configuration file using the patch command: ```bash flepimop patch config_sample_2pop.yml config_sample_2pop_outcomes_part.yml > config_new.yml @@ -43,6 +43,6 @@ You may provide an arbitrary number of separate configuration files to combine t ## Caveats -At this time, only `simulate` supports multiple configuration files. Also, the patching operation is fairly crude: if multiple configuration files specify the same option, this will yield an error. +At this time, only simulate directly supports multiple configuration files, and our current patching capabilities only allow for the addition of new sections as given in our tutorials. This is helpful for building models piece-by-piece from a simple compartmental forward simulation, to including outcome probabilities, and finally, adding modifier sections. If multiple configuration files specify the same higher level configuration chunks (e.g., seir, outcomes), this will yield an error. We are expanding coverage of this capability to other flepimop actions, e.g. inference, and are exploring options for smarter patching.