document vaccine efficacy

AMReX-Codes · Oct 17, 2023 · d51b31b · d51b31b
1 parent 14100fa
commit d51b31b
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/source/usage/how_to_run.rst b/docs/source/usage/how_to_run.rst
@@ -91,6 +91,8 @@ In addition to the ExaEpi inputs, there are also a number of runtime options tha
     one entry for each disease strain.
 * ``disease.reduced_inf`` (`float`, example: ``0.1``)
     The cross-strain reduction factor to the transmission probability.
+* ``disease.vac_eff`` (`float`, example: ``0.4``)
+    The vaccine efficacy - the probability of transmission will be multiplied by this factor
 
 In addition to the ExaEpi inputs, there are also a number of runtime options that can be configured for AMReX itself. Please see <https://amrex-codes.github.io/amrex/docs_html/GPU.html#inputs-parameters>`__ for more information on these options.