Files Generated by MGen Script¶

This section discusses how the mgen script saves files to disk, if you want to see a full MGen Script example using a MTut Script try Generate multiple data sets and Fit using a Two Compartment Model.

Outputs from an MGen Script called ‘builtin_mtut_example_mgen.pyml’ are as follows:-

builtin_mtut_example_mgen.pyml_output/
    _temp
    genpop_*
    compartment_diagram.dot
    compartment_diagram.svg

The ‘_temp’ folder contains the temporary functions generated by PoPy. The ‘compartment_diagram.dot’ file is a Graphviz file used to generate the ‘compartment_diagram.svg’ image file.

The main output of MGen Script are the multiple ‘genpop_*’ folders. Each of these folders contains the current sampled f[X] values and the synthetic data generated from the f[X] and the model.

Note the number of ‘genpop_*’ folders created by the MGen Script is determined by the ‘n_pop_samples’ in the OUTPUT_OPTIONS section:-

OUTPUT_OPTIONS: {n_pop_samples: 30}

The structure of each ‘genpop_*’ folder is as follows:-

builtin_mtut_example_mgen.pyml_output/
    genpop_*/
        clean_sol/
        noisy_sol/
        dupe_covars_data.csv
        gen_fx_params.txt

Here the ‘gen_fx_params.txt’ is a human readable text file containing the f[X] values for this population. The ‘dupe_covars_data.csv’ is an intermediate file used by PoPy when constructing a new data set. The ‘clean_sol’ folder contains a solution with no noise added. The ‘noisy_sol’ contains as solution with measurement noise added. For example the ‘noisy_sol’ folder contains these files:-

builtin_mtut_example_mgen.pyml_output/
    genpop_*/
        noisy_sol/
            fx_params.csv
            mx_params.csv
            rx_params.csv
            solution.pyml
            sx_params.csv
            synthetic_data.csv

Here the key file is ‘synthetic_data.csv’, which is the full synthetic data file generated for this population.

The other files represent intermediate variables for each time point, see Files Generated by Sim Script for more information.

Note the MGen Script has no OUTPUT_SCRIPTS section, so does not generate any child scripts unlike a Gen Script see Files Generated by Gen Script.