Pylint report from report.jinja2

Too many instance attributes (9/7)

Too many branches (17/12)

Too many instance attributes (14/7)

Too many arguments (7/5)

Trailing whitespace

break statement in finally block may swallow exception

Unnecessary "else" after "raise", remove the "else" and de-indent the code inside it

Consider explicitly re-raising using 'except (ValueError, KeyError) as exc' and 'raise ValueError(f'Given argument is not supported.\n{_handle_argv.__doc__}') from exc'

Too many local variables (18/15)

Too many statements (55/50)

Using open without explicitly specifying an encoding

Using open without explicitly specifying an encoding

Using open without explicitly specifying an encoding

Using open without explicitly specifying an encoding

Using open without explicitly specifying an encoding

Using open without explicitly specifying an encoding

Using open without explicitly specifying an encoding

Using open without explicitly specifying an encoding

Using open without explicitly specifying an encoding

Using open without explicitly specifying an encoding

Using open without explicitly specifying an encoding

Too many local variables (43/15)

Too many branches (19/12)

Too many statements (108/50)

Unreachable code

Unnecessary "elif" after "break", remove the leading "el" from "elif"

TODO: Check if this still works for new installs

Line too long (102/100)

Formatting a regular string which could be a f-string

Using open without explicitly specifying an encoding

Using an f-string that does not have any interpolated variables

Access to a protected member _make_modelica_normpath of a client class

Line too long (103/100)

Line too long (104/100)

Instance of 'DymolaAPI' has no 'dymola_path' member

Catching too general exception Exception

Unnecessary "else" after "raise", remove the "else" and de-indent the code inside it

Consider explicitly re-raising using 'except (ValueError, KeyError) as exc' and 'raise ValueError(f'Given argument is not supported.\n{_handle_argv.__doc__}') from exc'

Missing function or method docstring

Too many local variables (31/15)

Too many statements (59/50)

Unreachable code

Variable name "e" doesn't conform to snake_case naming style

Consider explicitly re-raising using 'raise KeyError(f'Given config file does not contain {value_error}. You need to specify this value in order to run the calibration.') from e'

Module 'aixcalibuha.utils.configuration' has no 'get_simulation_api_from_config' member

Redefining built-in 'map'

Module 'ebcpy.utils.conversion' has no 'convert_hdf_to_modelica_txt' member

Missing module docstring

Module name "e1_A_energy_system_analysis" doesn't conform to snake_case naming style

Line too long (107/100)

Line too long (108/100)

Formatting a regular string which could be a f-string

Formatting a regular string which could be a f-string

Unused variable 'fig'

Anomalous backslash in string: '\m'. String constant might be missing an r prefix.

Anomalous backslash in string: '\m'. String constant might be missing an r prefix.

Anomalous backslash in string: '\m'. String constant might be missing an r prefix.

Missing module docstring

Module name "e1_B_energy_system_analysis" doesn't conform to snake_case naming style

Line too long (108/100)

Import outside toplevel (examples.setup_fmu)

Formatting a regular string which could be a f-string

Unused variable 'fig'

Missing module docstring

Module name "e2_A_optimization_problem_definition" doesn't conform to snake_case naming style

Too many local variables (17/15)

Catching too general exception Exception

Catching too general exception Exception

Missing module docstring

Module name "e2_B_optimization_problem_definition" doesn't conform to snake_case naming style

Catching too general exception Exception

Catching too general exception Exception

Missing module docstring

Redefining name 'setup_fmu' from outer scope (line 74)

Redefining name 'setup_calibration_classes' from outer scope (line 74)

Import outside toplevel (examples.setup_fmu, examples.setup_calibration_classes)

Unused setup_fmu imported from examples

Unused setup_calibration_classes imported from examples

Missing module docstring

Too many arguments (7/5)

Too many local variables (20/15)

Import outside toplevel (examples.setup_fmu, examples.setup_calibration_classes)

Line too long (108/100)

Missing module docstring

Unrecognized option found: no-space-check

Useless option value for '--disable', 'print-statement' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'parameter-unpacking' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'unpacking-in-except' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'old-raise-syntax' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'backtick' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'import-star-module-level' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'apply-builtin' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'basestring-builtin' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'buffer-builtin' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'cmp-builtin' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'coerce-builtin' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'execfile-builtin' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'file-builtin' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'long-builtin' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'raw_input-builtin' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'reduce-builtin' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'standarderror-builtin' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'unicode-builtin' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'xrange-builtin' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'coerce-method' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'delslice-method' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'getslice-method' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'setslice-method' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'no-absolute-import' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'old-division' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'dict-iter-method' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'dict-view-method' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'next-method-called' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'metaclass-assignment' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'indexing-exception' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'raising-string' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'reload-builtin' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'oct-method' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'hex-method' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'nonzero-method' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'cmp-method' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'input-builtin' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'round-builtin' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'intern-builtin' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'unichr-builtin' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'map-builtin-not-iterating' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'zip-builtin-not-iterating' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'range-builtin-not-iterating' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'filter-builtin-not-iterating' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'using-cmp-argument' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'div-method' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'idiv-method' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'rdiv-method' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'exception-message-attribute' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'invalid-str-codec' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'sys-max-int' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'bad-python3-import' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'deprecated-string-function' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'deprecated-str-translate-call' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'deprecated-itertools-function' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'deprecated-types-field' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'next-method-defined' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'dict-items-not-iterating' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'dict-keys-not-iterating' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Useless option value for '--disable', 'dict-values-not-iterating' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.

Unknown option value for '--disable', expected a valid pylint message and got 'long-suffix'

Unknown option value for '--disable', expected a valid pylint message and got 'old-ne-operator'

Unknown option value for '--disable', expected a valid pylint message and got 'old-octal-literal'

Unknown option value for '--disable', expected a valid pylint message and got 'non-ascii-bytes-literal'

Unknown option value for '--disable', expected a valid pylint message and got 'locally-enabled'

Unknown option value for '--disable', expected a valid pylint message and got 'eq-without-hash'

Formatting a regular string which could be a f-string

Similar lines in 2 files
==bin.guided_setup:[64:102]
==bin.run_modelica_calibration:[26:44]
    __supported_argv = ["--config"]
    # Path to the script is irrelevant
    resulting_setting = {}
    _rel_argv = argv[1:]
    for arg in _rel_argv:
        try:
            name, value = arg.split("=")
            if name not in __supported_argv:
                raise KeyError
            else:
                resulting_setting[name] = value
        except (ValueError, KeyError):
            raise ValueError(f"Given argument is not supported.\n{_handle_argv.__doc__}")

    return resulting_setting


def _automatically_generate_mocate(model_name, savepath, packages=None, **kwargs):
    """
    Function to generate a MOdelica CAlibration TEmplates (MoCaTe)
    package for the given model inside the simulation api.

    :param str model_name:
        Name of the model you want to calibrate.
        If the model is a standalone model without a "package.mo" file,
        you have to pass the path the model. Else the path is extracted
        from the packages-list (see below)
    :param os.path.normpath,str savepath:
        Path to store the generated package
    :param list packages:
        List with filepath to the "package.mo" file of each package required
        to simulate the given model_name.
    :keyword str mocate_version
        Version number of used Modelica Calibration Templates Library. Default is 0.0.4
    :keyword str msl_version
        Version number of used Modelica Calibration Templates Library. Default is 3.2.3
    :return:
    """

Similar lines in 2 files
==examples.e2_A_optimization_problem_definition:[122:131]
==examples.e2_B_optimization_problem_definition:[113:122]
                                     index=new_index)
    try:
        goals.set_sim_target_data(sim_target_data)
    except Exception as err:
        print("I knew this error was going to happen. Do you understand "
              "why this happens based on the following message?")
        print(err)
    new_index = meas_target_data.index.values.copy()
    new_index[-10] += 0.05  # Change some value

Similar lines in 2 files
==examples.e2_A_optimization_problem_definition:[92:110]
==examples.e2_B_optimization_problem_definition:[82:100]
    }
    # To match the measured data to simulated data,
    # the index has to match with the simulation output
    # Thus, convert it:
    meas_target_data.to_float_index()
    # Lastly, setup the goals object. Note that the statistical_measure
    # is parameter of the python version of this example. It's a metric to
    # compare two set's of time series data. Which one to choose is up to
    # your expert knowledge. If you have no clue, raise an issue or read
    # basic literature on calibration.
    goals = Goals(
        meas_target_data=meas_target_data,
        variable_names=variable_names,
        statistical_measure=statistical_measure,
        weightings=[0.7, 0.3]
    )
    # Let's check if our evaluation is possible by creating some
    # dummy `sim_target_data` with the same index:

Similar lines in 2 files
==examples.e2_A_optimization_problem_definition:[213:222]
==examples.e2_B_optimization_problem_definition:[188:197]
    )
    return calibration_classes, validation_class


if __name__ == '__main__':
    main(
        examples_dir=pathlib.Path(__file__).parent,
        multiple_classes=True
    )

Similar lines in 2 files
==examples.e2_A_optimization_problem_definition:[197:207]
==examples.e2_B_optimization_problem_definition:[173:183]
    print([c.name for c in calibration_classes])
    calibration_classes_merged = merge_calibration_classes(calibration_classes)
    print([c.name for c in calibration_classes_merged])
    # Don't worry, the relevant_time_interval object keeps track
    # of which time intervals are relevant for the objective calculation
    print("Relevant time interval for class",
          calibration_classes_merged[0].name,
          calibration_classes_merged[0].relevant_intervals)
    # Let's also create an object to later validate our calibration:
    validation_class = CalibrationClass(

Similar lines in 2 files
==examples.e2_A_optimization_problem_definition:[132:158]
==examples.e2_B_optimization_problem_definition:[113:120]
                                     index=new_index)
    try:
        goals.set_sim_target_data(sim_target_data)
    except Exception as err:
        print("I knew this error was going to happen. Do you understand "
              "why this happens based on the following message?")
        print(err)

Similar lines in 2 files
==examples.e2_A_optimization_problem_definition:[122:129]
==examples.e2_B_optimization_problem_definition:[123:149]
                                     index=new_index)
    try:
        goals.set_sim_target_data(sim_target_data)
    except Exception as err:
        print("I knew this error was going to happen. Do you understand "
              "why this happens based on the following message?")
        print(err)
    # ## Calibration Classes
    # We now are going to wrap everything up into a single object called
    # `CalibrationClass`.
    # Each class has a `name`, a `start_time`, `stop_time` and
    # `goals`, `tuner_paras` (tuner parameters) and `inputs`.
    # The latter three can be set for all
    # classes if a distinction is not required.
    # ### Why do we use a `CalibrationClass`?
    # Because this class contains all information necessary
    # to perform both sensitivity analysis and calibration automatically.
    # ### Can there be multiple classes?
    # Yes! Because we expect different tuner parameters
    # to influence the outputs based on the state of the system,
    # e.g. 'On' and 'Off' more or less. To reduce the complexity of the
    # optimization problem, separating tuner parameters into time intervals
    # can be handy. For example heat losses to the ambient may be most
    # sensitive if the device is just turned off, while efficiency is more
    # sensitive during runtime.
    # Let's also define some different tuner parameters for the last stationary class.

Similar lines in 2 files
==examples.e2_A_optimization_problem_definition:[111:120]
==examples.e2_B_optimization_problem_definition:[101:111]
                                     index=meas_target_data.index)

    print("Goals data before setting simulation data:\n", goals.get_goals_data())
    goals.set_sim_target_data(sim_target_data)
    print("Goals data after setting simulation data:\n", goals.get_goals_data())
    print(statistical_measure, "of goals: ", goals.eval_difference())
    print("Verbose information on calculation", goals.eval_difference(verbose=True))
    # Lastly we advice to play around with the index of the sim_target_data to
    # understand the error messages of this framework a little bit better.
    # Example:

Similar lines in 2 files
==examples.e2_A_optimization_problem_definition:[70:84]
==examples.e2_B_optimization_problem_definition:[57:73]
    )
    print(tuner_paras)
    print("Names of parameters", tuner_paras.get_names())
    print("Initial values", tuner_paras.get_initial_values())
    # Scaling (will be done internally)
    print("Scaled initial values:\n", tuner_paras.scale(tuner_paras.get_initial_values()))

    # ## Goals
    # The evaluation of your goals (or mathematically speaking 'objective function')
    # depends on the difference of measured to simulated data.
    # Thus, you need to specify both measured and simulated data.
    #
    # Start by loading the measured data generated in 1_A_energy_system_analysis.py:
    data_dir = pathlib.Path(examples_dir).joinpath("data")

Similar lines in 2 files
==examples.e2_A_optimization_problem_definition:[10:58]
==examples.e2_B_optimization_problem_definition:[10:53]
import pathlib
# Imports from ebcpy
from ebcpy import TimeSeriesData
# Imports from aixcalibuha
from aixcalibuha import TunerParas, Goals, \
    CalibrationClass
from aixcalibuha.data_types import merge_calibration_classes


def main(
        examples_dir,
        statistical_measure="NRMSE",
        multiple_classes=True
):
    """
    Arguments of this example:

    :param [pathlib.Path, str] examples_dir:
        Path to the examples folder of AixCaliBuHA
    :param str statistical_measure:
        Measure to calculate the scalar of the objective,
        One of the supported methods in
        ebcpy.utils.statistics_analyzer.StatisticsAnalyzer
        e.g. RMSE, MAE, NRMSE
    :param bool multiple_classes:
        If False, all CalibrationClasses will have the
        same name
    """

    # ## Tuner Parameters
    # Tuner parameters are the optimization variables we will be
    # changing to match the simulated onto the measured output.
    #
    # As described in the first example (e1_A_energy_system_analysis),
    # we've changed four parameters in the model. To show the usefulness
    # of sensitivity analysis prior to calibration, we will add a fifth without
    # any influence, the heating curve declination of the heat pump.
    # To define tuner parameters, you have to specify
    # - the name of the parameter
    # - an initial guess
    # - boundaries as a (min, max) tuple.
    # Note that the initial guess is not always used by optimization routines.
    # We've chosen to make it a requirement to prevent blindly accepting
    # calibration results. If the result is very far away from your initial guess
    # and you though you understand the model, maybe the parameter is just not
    # sensitive or influenced by another parameter.
    # How to load the data is up to you. To make the structure clear,
    # we use a 3 element tuple in this example: