mfile_comparison

Python tool for comparing MFILE and outputting differences. The tool does not work for MFiles that are not the result of a full PROCESS run (ie if an error or exception occured).

Notes: + 24/11/2021: Global dictionary variables moved within the functions to avoid cyclic dependencies. This is because the dicts generation script imports, and inspects, process.

DICT_DESCRIPTIONS = get_dicts()['DICT_DESCRIPTIONS'] module-attribute

DEFAULT_COMPARE_PARAMS = ['rmajor', 'rminor', 'aspect', 'kappa', 'kappa95', 'triang', 'triang95', 'f_nd_impurity_electrons(01', 'f_nd_impurity_electrons(02', 'f_nd_impurity_electrons(03', 'f_nd_impurity_electrons(04', 'f_nd_impurity_electrons(05', 'f_nd_impurity_electrons(06', 'f_nd_impurity_electrons(07', 'f_nd_impurity_electrons(08', 'f_nd_impurity_electrons(09', 'f_nd_impurity_electrons(10', 'f_nd_impurity_electrons(11', 'f_nd_impurity_electrons(12', 'f_nd_impurity_electrons(13', 'f_nd_impurity_electrons(14', 'a_plasma_surface', 'vol_plasma', 'n_tf_coils', 'dr_shld_inboard', 'dr_shld_outboard', 'dr_blkt_inboard', 'dr_blkt_outboard', 'p_fusion_total_mw', 'plasma_current_MA', 'b_plasma_toroidal_on_axis', 'q95', 'beta_poloidal_vol_avg', 'temp_plasma_electron_vol_avg_kev', 'nd_plasma_electrons_vol_avg', 'hfact', 'vs_cs_pf_total_pulse', 'b_plasma_toroidal_on_axis', 'b_tf_inboard_peak_with_ripple', 'tmarg', 'iooic', 'sig_tf_case', 'sig_tf_wp', 'sig_tf_case_max', 'sig_tf_wp_max', 'p_plant_electric_gross_mw', 'p_coolant_pump_elec_total_mw', 'p_plant_electric_net_mw', 'pflux_fw_neutron_mw', 'f_nd_alpha_electron', 'p_plasma_inner_rad_mw', 'p_plasma_rad_mw', 'p_blkt_nuclear_heat_total_mw', 'p_shld_nuclear_heat_mw', 'p_plasma_separatrix_mw', 'p_hcd_primary_extra_heat_mw', 'f_c_plasma_bootstrap', 'f_c_plasma_auxiliary', 'f_c_plasma_inductive', 'gamnb', 'e_beam_kev', 'p_plasma_loss_mw'] module-attribute

BASELINE_LIST = ['procver', 'time', 'username', 'tagno', 'commsg', 'ifail', 'rmajor', 'rminor', 'aspect', 'kappa', 'kappa95', 'triang', 'triang95', 'a_plasma_surface', 'vol_plasma', 'n_tf_coils', 'p_fusion_total_mw', 'plasma_current_MA', 'b_plasma_toroidal_on_axis', 'q95', 'beta_total_vol_avg', 'normalised_thermal_beta', 'beta_norm_total', 'thermal_beta', 'thermal_poloidal_beta', 'temp_plasma_electron_vol_avg_kev', 'temp_plasma_electron_on_axis_kev', 'nd_plasma_electrons_vol_avg', 'nd_plasma_electron_on_axis', 'dnla_gw', 'temp_plasma_separatrix_kev', 'nd_plasma_separatrix_electron', 'temp_plasma_pedestal_kev', 'nd_plasma_pedestal_electron', 'n_charge_plasma_effective_vol_avg', 'nd_plasma_impurities_vol_avg', 't_energy_confinement', 'hfact', 'tauelaw', 'f_nd_alpha_electron', 'pflux_fw_neutron_mw', 'p_plasma_inner_rad_mw', 'p_plasma_sync_mw', 'p_plasma_rad_mw', 'p_blkt_nuclear_heat_total_mw', 'p_shld_nuclear_heat_mw', 'p_plasma_separatrix_mw', 'life_div_fpy', 'p_plant_primary_heat_mw', 'dr_bore', 'dr_cs', 'dr_cs_precomp', 'dr_cs_tf_gap', 'dr_tf_inboard', 'deltf', 'dr_shld_thermal_inboard', 'dr_shld_thermal_outboard', 'dz_shld_thermal', 'dr_shld_vv_gap_inboard', 'dr_vv_inboard', 'dr_vv_outboard', 'dz_vv_upper', 'dz_vv_lower', 'dr_shld_inboard', 'dr_shld_blkt_gap', 'dr_blkt_inboard', 'dr_fw_inboard', 'dr_fw_plasma_gap_inboard', 'dr_fw_plasma_gap_outboard', 'dr_fw_outboard', 'dr_blkt_outboard', 'dr_shld_outboard', 'dr_shld_vv_gap_outboard', 'dr_tf_shld_gap', 'dr_tf_outboard', 'eta_turbine', 'p_plant_electric_gross_mw', 'p_plant_electric_net_mw', 'p_hcd_injected_total_mw', 'p_hcd_primary_extra_heat_mw', 'f_c_plasma_bootstrap', 'f_c_plasma_auxiliary', 'f_c_plasma_inductive', 'gamnb', 'e_beam_kev', 'p_plasma_loss_mw', 'p_plasma_separatrix_mw', 'vssoft', 'vs_cs_pf_total_pulse', 't_plant_pulse_burn', 'b_tf_inboard_peak_symmetric', 'iooic', 'tmarg', 'tftmp', 'qtarget', 'qtargetcomplete', 'totalpowerlost'] module-attribute

BLANKET_COMPARE_PARAMS = ['dr_blkt_inboard', 'dr_blkt_outboard', 'p_fusion_total_mw', 'p_blkt_nuclear_heat_total_mw', 'p_fw_nuclear_heat_total_mw', 'p_tf_nuclear_heat_mw', 'p_shld_nuclear_heat_mw', 'p_div_nuclear_heat_total_mw', 'tbr', 'f_blkt_li6_enrichment', 'a_fw_total', 'f_p_blkt_multiplication'] module-attribute

GENERIC_LIST = ['rmajor', 'rminor', 'aspect', 'kappa', 'kappa95', 'triang', 'triang95', 'p_fusion_total_mw', 'plasma_current_MA', 'b_plasma_toroidal_on_axis', 'q95', 'beta_total_vol_avg', 'temp_plasma_electron_vol_avg_kev', 'nd_plasma_electrons_vol_avg', 'p_hcd_injected_total_mw', 'p_plant_electric_net_mw', 'pflux_fw_neutron_mw', 'pflux_fw_rad_mw', 'f_nd_alpha_electron', 'p_plasma_inner_rad_mw', 'p_plasma_rad_mw', 'f_c_plasma_bootstrap', 'pdivmax_over_rmajor', 'f_nd_impurity_electrons(14', 'eta_turbine', 'capcost', 'coe', 'dr_bore', 'dr_cs', 'dr_cs_precomp', 'dr_cs_tf_gap', 'dr_tf_inboard', 'dr_tf_shld_gap', 'dr_shld_thermal_inboard', 'dr_shld_thermal_outboard', 'dz_shld_thermal', 'dr_shld_vv_gap_inboard', 'dr_vv_inboard', 'dr_shld_inboard', 'dr_shld_blkt_gap', 'dr_blkt_inboard', 'dr_fw_inboard', 'dr_fw_plasma_gap_inboard', 'dr_fw_plasma_gap_outboard', 'dr_fw_outboard', 'dr_blkt_outboard', 'dr_shld_outboard', 'dr_vv_outboard', 'dr_shld_vv_gap_outboard', 'dr_tf_shld_gap', 'dr_tf_outboard', 'dz_xpoint_divertor', 'dz_divertor', 'dz_vv_lower', 'dz_shld_lower', 'dz_shld_vv_gap'] module-attribute

parser = argparse.ArgumentParser(description='Produce a comparison between two PROCESS MFILEs. User Can specify level of differences to show. For info contact james.morris2@ccfe.ac.uk') module-attribute

args = parser.parse_args() module-attribute

BColors

Source code in process/core/io/mfile_comparison.py

class BColors:
    HEADER = "\033[95m"
    OKBLUE = "\033[94m"
    OKGREEN = "\033[92m"
    WARNING = "\033[93m"
    FAIL = "\033[91m"
    ENDC = "\033[0m"

HEADER = '\x1b[95m' class-attribute instance-attribute

OKBLUE = '\x1b[94m' class-attribute instance-attribute

OKGREEN = '\x1b[92m' class-attribute instance-attribute

WARNING = '\x1b[93m' class-attribute instance-attribute

FAIL = '\x1b[91m' class-attribute instance-attribute

ENDC = '\x1b[0m' class-attribute instance-attribute

main(arg)

Main function for comparing MFILEs

Parameters:

Name	Type	Description	Default
arg		List of arguments	required

Source code in process/core/io/mfile_comparison.py

def main(arg):
    """Main function for comparing MFILEs

    Parameters
    ----------
    arg :
        List of arguments
    """

    print_counter = 0
    n = 2
    mfile_list = []
    for item in arg.f:
        mfile = mf.MFile(filename=item)
        if mfile.data["error_status"].get_scan(-1) == 3:
            raise RuntimeError(
                f"{item} is an MFile from a PROCESS run that did not converge"
                " and instead results from an error during the run"
            )

        mfile_list.append(mfile)

    var_list = []
    missing_vars = []
    diff_list = []
    within_list = []

    key_list = mfile_list[0].data.keys()
    for var in key_list:
        store = True
        for f in mfile_list:
            if var not in f.data:
                store = False
                missing_vars.append(var)

        if store:
            var_list.append(var)

    if arg.defaults:
        var_list = DEFAULT_COMPARE_PARAMS

    if arg.blanket:
        var_list = BLANKET_COMPARE_PARAMS

    if arg.baseline:
        var_list = BASELINE_LIST

    if arg.generic:
        var_list = GENERIC_LIST

    for v in var_list:
        if "normres" in v:
            continue

        values = np.zeros(n)  # replaced scipy with numpy

        if v not in get_dicts()["DICT_VAR_TYPE"]:
            try:
                eval(mfile_list[0].data[v].get_scan(-1))
            except NameError:
                pass
            except TypeError:
                for m in range(len(mfile_list)):
                    values[m] = mfile_list[m].data[v].get_scan(-1)
            except SyntaxError:
                pass

        elif (
            get_dicts()["DICT_VAR_TYPE"][v] == "real_variable"
            or get_dicts()["DICT_VAR_TYPE"][v] == "int_variable"
        ):
            for m in range(len(mfile_list)):
                values[m] = mfile_list[m].data[v].get_scan(-1)

        norm_vals = []
        if values[0] != 0 and isfinite(values[0]):
            norm_vals = values / values[0]
        # else:
        #    print(key, values[0])

        if len(norm_vals) >= 1:
            key = v.strip(".").strip(" ")
            des = get_dicts()["DICT_DESCRIPTIONS"].get(key, "-")
            a = norm_vals >= 1.0 + arg.acc / 100.0
            b = norm_vals <= 1.0 - arg.acc / 100.0
            if a[1]:
                diff_list.append(v)
                line = (
                    BColors.ENDC
                    + v
                    + "\t"
                    + des
                    + "\t"
                    + str(values[0])
                    + "\t"
                    + str(values[1])
                    + "\t"
                    + BColors.FAIL
                    + str(round((norm_vals[1] - 1) * 100.0, 2))
                    + " %"
                )
                wline = (
                    v
                    + "\t"
                    + des
                    + "\t"
                    + "\t"
                    + str(values[0])
                    + "\t"
                    + str(values[1])
                    + "\t"
                    + str(round((norm_vals[1] - 1) * 100.0, 2))
                    + " %"
                )
                print(line)
                print_counter += 1
                if arg.save:
                    with open("comp.txt", "a") as ofile:
                        ofile.write(wline + "\n")
            elif b[1]:
                diff_list.append(v)
                line = (
                    BColors.ENDC
                    + v
                    + "\t"
                    + des
                    + "\t"
                    + str(values[0])
                    + "\t"
                    + str(values[1])
                    + "\t"
                    + BColors.FAIL
                    + str(round((norm_vals[1] - 1) * 100.0, 2))
                    + " %"
                )
                wline = (
                    v
                    + "\t"
                    + des
                    + "\t"
                    + str(values[0])
                    + "\t"
                    + str(values[1])
                    + "\t"
                    + str(round((norm_vals[1] - 1) * 100.0, 2))
                    + " %"
                )
                print(line)
                print_counter += 1
                if arg.save:
                    with open("comp.txt", "a") as ofile:
                        ofile.write(wline + "\n")
            else:
                within_list.append(v)
                line = (
                    BColors.ENDC
                    + v
                    + "\t"
                    + des
                    + "\t"
                    + str(values[0])
                    + "\t"
                    + str(values[1])
                    + "\t"
                    + str(round((norm_vals[1] - 1) * 100.0, 2))
                    + " %"
                )
                wline = (
                    v
                    + "\t"
                    + des
                    + "\t"
                    + str(values[0])
                    + "\t"
                    + str(values[1])
                    + "\t"
                    + str(round((norm_vals[1] - 1) * 100.0, 2))
                    + " %"
                )
                if arg.verbose:
                    print(line)
                    print_counter += 1
                    with open("comp.txt", "a") as ofile:
                        ofile.write(wline + "\n")

    if arg.baseline and arg.acc >= 10.0:
        if print_counter == 0:
            sys.exit(0)
        else:
            sys.exit(f"Differences in baseline output by more than {arg.acc}%")