cocopp.rungenericmany module documentation

Main routine for post-processing the data of multiple algorithms.

Provided with some data, this routine outputs figure and TeX files
in a folder needed for the compilation of the provided LaTeX templates
for comparing multiple algorithms (``*many.tex`` or ``*3*.tex``).
The used template file needs to be edited so that the commands
``\bbobdatapath`` points to the output folder created by this routine.

These output files will contain performance tables, performance
scaling figures and empirical cumulative distribution figures. On
subsequent executions, new files will be added to the output folder,
overwriting existing older files in the process.

Keyword arguments:

*argv* -- list of strings containing options and arguments. If not
provided, sys.argv is accessed.

*argv* must list folders containing BBOB data files.
The name of these folders will be used in the output figures and
tables to designate the algorithms. Therefore you should name the
folders with differentiating names.

Furthermore, argv can begin with facultative option flags listed
below.

    -h, --help
        displays this message.
    -v, --verbose
        verbose mode, prints out operations, warnings.
    -o OUTPUTDIR, --output-dir=OUTPUTDIR
        changes the default output directory (:file:`ppdatamany`) to
        :file:`OUTPUTDIR`.
    --noise-free, --noisy
        processes only part of the data.
    --settings=SETTINGS
        changes the style of the output figures and tables. At the
        moment the only differences are  in the colors of the output
        figures. SETTINGS can be either "grayscale" or "color".
        The default setting is "color".
    --tab-only, --rld-only, --fig-only
        these options can be used to output respectively the
        comparison TeX tables, the run lengths distributions or the
        figures of aRT/dim vs dim only. A combination of any two or
        more of these options results in no output.
    --no-rld-single-fcts
        do not generate runlength distribution figures for each
        single function.
    --expensive
        runlength-based f-target values and fixed display limits,
        useful with comparatively small budgets.
    --no-svg
        do not generate the svg figures which are used in html files
    -

Exceptions raised:

*Usage* -- Gives back a usage message.

Examples:

* Calling the rungenericmany.py interface from the command line::

    $ python -m cocopp.rungenericmany -v AMALGAM BFGS BIPOP-CMA-ES


* Loading this package and calling the main from the command line
  (requires that the path to this package is in python search path)::

    $ python -m cocopp.rungenericmany -h

  This will print out this help message.

* From the python interpreter (requires that the path to this
  package is in python search path)::

    >> import cocopp
    >> cocopp.rungenericmany.main('-o outputfolder folder1 folder2'.split())

  This will execute the post-processing on the data found in
  :file:`folder1` and :file:`folder2`.
  The ``-o`` option changes the output folder from the default to
  :file:`outputfolder`.

* Generate post-processing data for some algorithms with figures in
  shades of gray::

    $ python rungenericmany.py --settings grayscale NEWUOA NELDER LSSTEP