.. _files_generated_by_mcomp_script:

Files Generated by MComp Script
=================================
    
This section discusses how the mcomp script saves files to disk, if you want to see a full :ref:`mcomp_script` example using a :ref:`mtut_script` try :ref:`builtin_mtut_example`.
    
Output from an :ref:`mcomp_script` called 'builtin_mtut_example_mcomp.pyml' are as follows:-
    
.. code-block::
    
    builtin_mtut_example_mcomp.pyml_output/
        _temp
        fx_scatter
        mcomp_sections
        mfit_sections
        mgen_sections
        final_fx.csv
        gt_fx.csv
        init_fx.csv
        type_fx.csv
        
The '_temp' folder contains the temporary functions generated by |popy|. The 'fx_scatter' folder contains the scatter plots of fitted vs true |fx|. For example files like:-

.. code-block::

    builtin_mtut_example_mcomp.pyml_output/
        fx_scatter/
            fitted_vs_true_for_f[cl].svg
            fitted_vs_true_for_f[ka].svg
            fitted_vs_true_for_f[pnoise].svg
            ..

The folders named '\*_sections', just contain the original \.pyml scripts in sections for use in the |popy| documentation.

The \.csv files are as follows:-

.. _table_mcomp_output_csv_files:

.. list-table:: \.csv file output by :ref:`mcomp_script`
    :header-rows: 1
    
    * - Filename
      - Contents

    * - final_fx.csv
      - Each row contains |fx| estimates for one population
      
    * - gt_fx.csv
      - Each row contains true |fx| values for one population

    * - init_fx.csv
      - Each row contains starting |fx| values for one population
      
    * - type_fx.csv
      - Each row contains |fx| type (e.g. main or var |fx|) 
      
Note each of the \*_fx.csv files has the same number of rows and columns, so you could easily load this data into |r| for further analysis if you like.


  


