---------------------------------------------------
lines 19-77 of file: devel/cmd/simulate_command.cpp
---------------------------------------------------

{xrst_begin simulate_command}

The Simulate Command
####################

Syntax
******
``dismod_at`` *database* ``simulate`` *number_simulate*

database
********
Is an
`sqlite <https://sqlite.org/index.html>`_ database containing the
``dismod_at`` :ref:`input-name` tables which are not modified.

number_simulate
***************
Is the number of simulations. Each simulation contains a complete
data set.

meas_value
**********
The :ref:`data_table@meas_value` in the data
table is not used.

truth_var_table
***************
The :ref:`truth_var_table-name` is an addition input table for this command.
It specifies the values for the
:ref:`model_variables-name` used during the simulation.
This table can be create by the
:ref:`set_command<set_command@table_out@truth_var>` ,
or the user can create it directly with the aid of the
:ref:`var_table-name` (created by the :ref:`init_command-name` ).

data_sim_table
**************
A new :ref:`data_sim_table-name` is created by this command.
It contains *number_simulate* values
for each :ref:`data_subset_table@data_id` in the data_subset table.
Hence the number of rows in :ref:`data_sim_table-name` is
*number_simulate* times the number of rows in :ref:`data_subset_table-name` .

prior_sim_table
***************
A new :ref:`prior_sim_table-name` is created by this command.
It contains *number_simulate* values
for each :ref:`var_table@var_id` in the var table.
Hence the number of rows in :ref:`data_sim_table-name` is
*number_simulate* times the number of rows in :ref:`var_table-name` .
{xrst_toc_hidden
    example/get_started/simulate_command.py
}
Example
*******
The file :ref:`simulate_command.py-name` contains an example and test
using this command.

{xrst_end simulate_command}