cv_experiments_main.py

"""
########################################### cv_experiments_main.py #########################################
Authors: Marcel Reith-Braun (ISAS, marcel.reith-braun@kit.edu), Jakob Thumm
#######################################################################################################
Defines and executes experiments (first-passage time problems) for the constant velocity model.
See cv_process_main.py for details.

usage:
 - run docker container - tested with tensorflow/approx_fptd:2.8.0-gpu image:
    $ docker run -u $(id -u):$(id -g) \\
            -it --rm \\
            -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix \\
            -v </path/to/repo>:/mnt \\
            tensorflow/approx_fptd:2.8.0-gpu
 - within container:
     $   python3 /mnt/cv_experiments_main.py \\
requirements:
  - Required packages/tensorflow/approx_fptd:2.8.0-gpu image: See corresponding dockerfile.
  - Volume mounts: Specify a path </path/to/repo/> that points to the repo.
"""

from absl import logging
from absl import app
from absl import flags

from cv_process_main import run_experiment, run_experiment_with_extent
from experiments_runner import get_experiments_by_name, add_defaults, convert_to_numpy, store_config

# Delete all FLAGS defined by CV process as we here not want them to be overwritten by the following flags.
for name in list(flags.FLAGS):
    if name in ['load_samples', 'save_samples', 'save_path', 'save_results', 'result_dir', 'no_show', 'for_paper',
                'measure_computational_times', 'with_extents', 'verbosity_level']:
        delattr(flags.FLAGS, name)

flags.DEFINE_bool('load_samples', default=False,
                  help='Whether the samples should be loaded from a .npz  file.')
flags.DEFINE_bool('save_samples', default=False,
                  help='Whether the samples should be saved to a .npz  file.')
flags.DEFINE_string('save_dir', default='/mnt/',
                    help='The path to save the .npz  file.')
flags.DEFINE_bool('save_results', default=False,
                  help='Whether to save the results.')
flags.DEFINE_string('result_dir', default='/mnt/results/',
                    help='The directory where to save the results.')
flags.DEFINE_bool('no_show', default=False,
                  help='Set this to True if you do not want to show evaluation graphics and only save them.')
flags.DEFINE_bool('for_paper', default=False,
                  help='Boolean, whether to use the plots for publication (omit headers, etc.)..')
flags.DEFINE_bool('measure_computational_times', default=False,
                  help='Whether to measure the computational times. This is only considered if with_extends is False.')
flags.DEFINE_bool('with_extents', default=False,
                  help='Whether to run experiments based on a point-based (False) or extent-based representation of a particle (True).')

flags.DEFINE_string('verbosity_level', default='INFO', help='Verbosity options.')
flags.register_validator('verbosity_level',
                         lambda value: value in ['FATAL', 'ERROR', 'WARNING', 'INFO', 'DEBUG'],
                         message='dataset_type must one of ' + str(['FATAL', 'ERROR', 'WARNING', 'INFO', 'DEBUG']))

FLAGS = flags.FLAGS


# Experiments config
# List of dictionaries describing experiments
# The syntax of each dictionary is:
"""
{
    # Experiment name
    "experiment_name": "CV_Long_Track_Sw1",
    # Process parameters
    "x_L": [0.3, 6.2, 0.5, 0.2],
    "C_L": [[2E-7, 2E-5, 0, 0], [2E-5, 6E-3, 0, 0], [0, 0, 2E-7, 2E-5], [0, 0, 2E-5, 6E-3]],
    "t_L": 0,
    "S_w": 1,
    # Boundary
    "x_predTo": 0.6458623971412047,
    # Particle size (only required for experiments with extents)
        "particle_size": [0.08, 0.08],
    # Plot settings (optional)
    "t_range": [t_min, t_max], (floats, defaults by cv_process)
    "y_range": [y_min, y_max], (floats, defaults by cv_process)
    "t_range_with_extents": [t_min, t_max], (floats, defaults by cv_process_with_extents)
    "y_range_with_extents": [y_min, y_max], (floats, defaults by cv_process_with_extents)
    # Units (optional)
    "time_unit": "s",
    "length_unit": "m",
    # Paths and directories (optional)
    "save_path": ..., (string, default by main function)
    "results_dir": ..., (string, default by main function)
}
"""

experiments_config = [
    {
        # Experiment name
        "experiment_name": "CV_Long_Track_Sw1",
        # Process parameters
        "x_L": [0.3, 6.2, 0.5, 0.2],
        "C_L": [[2E-7, 2E-5, 0, 0], [2E-5, 6E-3, 0, 0], [0, 0, 2E-7, 2E-5], [0, 0, 2E-5, 6E-3]],
        "t_L": 0,
        "S_w": 1,
        # Boundary
        "x_predTo": 0.6458623971412047,
        # Particle size
        "particle_size": [0.08, 0.08],
        # Plot settings (optional)
        "t_range": [0.05, 0.065],
        "y_range": [0.46, 0.56],
        # Units (optional)
        "time_unit": "normalized time",
        "length_unit": "normalized length",
    }, {
        # Experiment name
        "experiment_name": "CV_Long_Track_Sw1_denorm",
        # Process parameters
        "x_L": [29.0304,  599.9616, 64.96,  25.984],
        "C_L": [[1.87280916e-03, 1.87280916e-01, 0, 0],
                [1.87280916e-01, 5.61842749e+01, 0, 0],
                [0, 0, 3.37584128e-03, 3.37584128e-01],
                [0, 0, 3.37584128e-01, 1.01275238e+02]],
        "t_L": 0,
        "S_w": 9364.045824,
        # Boundary
        "x_predTo": 62.5,
        # Particle size
        "particle_size": [8, 8],
        # Plot settings (optional)
        "t_range": [0.05, 0.062],
        "y_range": [62, 71],
        "t_range_with_extents": [0.042, 0.072],
        "y_range_with_extents": [58, 76],
        # Units (optional)
        "time_unit": "s",
        "length_unit": "mm",
    }, {
        # Experiment name
        "experiment_name": "CV_Long_Track_Sw10",
        # Process parameters
        "x_L": [0.3, 6.2, 0.5, 0.2],
        "C_L": [[2E-7, 2E-5, 0, 0], [2E-5, 6E-3, 0, 0], [0, 0, 2E-7, 2E-5], [0, 0, 2E-5, 6E-3]],
        "t_L": 0,
        "S_w": 10,
        # Boundary
        "x_predTo": 0.6458623971412047,
        # Particle size
        "particle_size": [0.08, 0.08],
        # Units (optional)
        "time_unit": "normalized time",
        "length_unit": "normalized length",
    },  {
        # Experiment name
        "experiment_name": "CV_Long_Track_Sw10_denorm",
        # Process parameters
        "x_L": [29.0304, 599.9616, 64.96, 25.984],
        "C_L": [[1.87280916e-03, 1.87280916e-01, 0, 0],
                [1.87280916e-01, 5.61842749e+01, 0, 0],
                [0, 0, 3.37584128e-03, 3.37584128e-01],
                [0, 0, 3.37584128e-01, 1.01275238e+02]],
        "t_L": 0,
        "S_w": 93640.45824,
        # Boundary
        "x_predTo": 62.5,
        # Particle size
        "particle_size": [8, 8],
        # Plot settings (optional)
        "t_range": [0.04, 0.08],
        "y_range": [55, 77],
        "t_range_with_extents": [0.033, 0.09],
        "y_range_with_extents": [52, 85],
        # Units (optional)
        "time_unit": "s",
        "length_unit": "mm",
    },  {
        # Experiment name
        "experiment_name": "CV_Long_Track_Sw100",
        # Process parameters
        "x_L": [0.3, 6.2, 0.5, 0.2],
        "C_L": [[2E-7, 2E-5, 0, 0], [2E-5, 6E-3, 0, 0], [0, 0, 2E-7, 2E-5], [0, 0, 2E-5, 6E-3]],
        "t_L": 0,
        "S_w": 100,
        # Boundary
        "x_predTo": 0.6458623971412047,
        # Particle size
        "particle_size": [0.08, 0.08],
        # Plot settings (optional)
        "t_range": [0.0, 0.25],
        "y_range": [0.2, 1.3],
        # Units (optional)
        "time_unit": "normalized time",
        "length_unit": "normalized length",
    },  {
        # Experiment name
        "experiment_name": "CV_Long_Track_Sw100_denorm",
        # Process parameters
        "x_L": [29.0304, 599.9616, 64.96, 25.984],
        "C_L": [[1.87280916e-03, 1.87280916e-01, 0, 0],
                [1.87280916e-01, 5.61842749e+01, 0, 0],
                [0, 0, 3.37584128e-03, 3.37584128e-01],
                [0, 0, 3.37584128e-01, 1.01275238e+02]],
        "t_L": 0,
        "S_w": 9364054.5824,
        # Boundary
        "x_predTo": 62.5,
        # Particle size
        "particle_size": [8, 8],
        # Plot settings (optional)
        "t_range": [0.0, 0.25],
        "y_range": [0, 150],
        "t_range_with_extents": [0.01, 0.3],
        "y_range_with_extents": [-50, 200],
        # Units (optional)
        "time_unit": "s",
        "length_unit": "mm",
    },  {
        # Experiment name
        "experiment_name": "CV_Long_Track_Sw300",
        # Process parameters
        "x_L": [0.3, 6.2, 0.5, 0.2],
        "C_L": [[2E-7, 2E-5, 0, 0], [2E-5, 6E-3, 0, 0], [0, 0, 2E-7, 2E-5], [0, 0, 2E-5, 6E-3]],
        "t_L": 0,
        "S_w": 300,
        # Boundary
        "x_predTo": 0.6458623971412047,
        # Particle size
        "particle_size": [0.08, 0.08],
        # Plot settings (optional)
        "t_range": [0.0, 0.25],
        "y_range": [0.0, 1.5],
        # Units (optional)
        "time_unit": "normalized time",
        "length_unit": "normalized length",
    }, {
        # Experiment name
        "experiment_name": "CV_Long_Track_High_Initial_Noise",
        # Process parameters
        "x_L": [0.3, 6.2, 0.5, 0.2],
        "C_L": [[3.2E-3, 5.9E-4, 0, 0], [5.9E-4, 5.3, 0, 0], [0, 0, 3.2E-5, 5.9E-3], [0, 0, 5.9E-3, 5.3]],
        "t_L": 0,
        "S_w": 10,
        # Boundary
        "x_predTo": 0.6458623971412047,
        # Particle size
        "particle_size": [0.08, 0.08],
        # Units (optional)
        "time_unit": "normalized time",
        "length_unit": "normalized length",
    }, {
        # Experiment name
        "experiment_name": "CV_Long_Track_High_tL",
        # Process parameters
        "x_L": [0.3, 6.2, 0.5, 0.2],
        "C_L": [[2E-7, 2E-5, 0, 0], [2E-5, 6E-3, 0, 0], [0, 0, 2E-7, 2E-5], [0, 0, 2E-5, 6E-3]],
        "t_L": 5,
        "S_w": 10,
        # Boundary
        "x_predTo": 0.6458623971412047,
        # Particle size
        "particle_size": [0.08, 0.08],
        # Units (optional)
        "time_unit": "normalized time",
        "length_unit": "normalized length",
    }, {
        # Experiment name
        "experiment_name": "CV_Short_Track_Sw18",
        # Process parameters
        "x_L": [0.3, 6.2, 0.5, 0.2],
        "C_L": [[3.2E-7, 5.9E-5, 0, 0], [5.9E-5, 5.3E-2, 0, 0], [0, 0, 3.2E-7, 5.9E-5], [0, 0, 5.9E-5, 5.3E-2]],
        "t_L": 0,
        "S_w": 18,
        # Boundary
        "x_predTo": 0.6458623971412047,
        # Particle size
        "particle_size": [0.08, 0.08],
        # Units (optional)
        "time_unit": "normalized time",
        "length_unit": "normalized length",
    }, {
        # Experiment name
        "experiment_name": "CV_Long_Track_Sw10_slow",
        # Process parameters
        "x_L": [0.3, 3.2, 0.5, 0.2],
        "C_L": [[2E-7, 2E-5, 0, 0], [2E-5, 6E-3, 0, 0], [0, 0, 2E-7, 2E-5], [0, 0, 2E-5, 6E-3]],
        "t_L": 0,
        "S_w": 10,
        # Boundary
        "x_predTo": 0.6458623971412047,
        # Plot settings (optional)
        "t_range": [0.07, 0.3],
        "y_range": [0.0, 1.5],
        # Particle size
        "particle_size": [0.08, 0.08],
        # Units (optional)
        "time_unit": "normalized time",
        "length_unit": "normalized length",
    },  {
        # Experiment name
        "experiment_name": "CV_Long_Track_Sw1_slow_denorm",
        # Process parameters
        "x_L": [29.0304, 400, 64.96, 25.984],
        "C_L": [[1.87280916e-03, 1.87280916e-01, 0, 0],
                [1.87280916e-01, 5.61842749e+01, 0, 0],
                [0, 0, 3.37584128e-03, 3.37584128e-01],
                [0, 0, 3.37584128e-01, 1.01275238e+02]],
        "t_L": 0,
        "S_w": 9364.045824,
        # Boundary
        "x_predTo": 62.5,
        # Particle size
        "particle_size": [8, 8],
        # Plot settings (optional)
        "t_range": [0.07, 0.105],
        "y_range": [60, 75],
        "t_range_with_extents": [0.06, 0.12],
        "y_range_with_extents": [55, 80],
        # Units (optional)
        "time_unit": "s",
        "length_unit": "mm",
    },
]


def main(args):
    del args

    # setup logging
    logging.set_verbosity(logging.FLAGS.verbosity_level)

    # define the experiments to execute by name
    # experiments_name_list = ['CV_Long_Track_Sw1', 'CV_Long_Track_Sw100', 'CV_Long_Track_Sw300']
    # experiments_name_list = ['CV_Long_Track_Sw1_denorm', 'CV_Long_Track_Sw10_denorm', 'CV_Long_Track_Sw100_denorm', 'CV_Long_Track_Sw1_slow_denorm']
    experiments_name_list = ['CV_Long_Track_Sw100_denorm']

    # get the configs
    experiments_list = get_experiments_by_name(experiments_name_list, experiments_config)

    # add the defaults (if necessary)
    add_defaults(experiments_list, FLAGS)

    # run the experiments and store the configs
    for i, config in enumerate(experiments_list):
        store_config(config, FLAGS.save_results)
        convert_to_numpy(config)  # convert the configs entries to numpy arrays
        logging.info('Running experiment {}.'.format(config['experiment_name']))
        del config['experiment_name']  # name cannot be passed to run_experiment

        if not FLAGS.with_extents:
            if 't_range_with_extents' in config.keys():
                del config['t_range_with_extents']  # t_range_with_extents cannot be passed to run_experiment
            if 'y_range_with_extents' in config.keys():
                del config['y_range_with_extents']
            run_experiment(**config,
                           for_paper=FLAGS.for_paper,
                           measure_computational_times=True if FLAGS.measure_computational_times and i == 0 else False)
            # by default, takes the first defined experiment for measuring the computational times.
        else:
            if 't_range' in config.keys():
                del config['t_range']
            if 'y_range' in config.keys():
                del config['y_range']
            run_experiment_with_extent(**config,
                                       for_paper=FLAGS.for_paper)


if __name__ == "__main__":
    app.run(main)