evaluator package

Define tools to evaluate a fit quality.

Subpackages

• simulation_output package
  • Submodules
    • factory module
      • SimulationOutputEvaluatorFactory
        • SimulationOutputEvaluatorFactory.__init__()
        • SimulationOutputEvaluatorFactory.run_from_kw()
        • SimulationOutputEvaluatorFactory.run_from_preset()
        • SimulationOutputEvaluatorFactory.run_all()
    • presets module
      • presets_for_fault_scenario_rel_diff_at_some_element()
      • presets_for_fault_scenario_rms_over_full_linac()
    • simulation_output_evaluator module
      • SimulationOutputEvaluator
        • SimulationOutputEvaluator.value_getter
        • SimulationOutputEvaluator.ref_simulation_output
        • SimulationOutputEvaluator.ref_value_getter
        • SimulationOutputEvaluator.post_treaters
        • SimulationOutputEvaluator.tester
        • SimulationOutputEvaluator.descriptor
        • SimulationOutputEvaluator.markdown
        • SimulationOutputEvaluator.plt_kwargs
        • SimulationOutputEvaluator.raise_error_if_value_getter_returns_none
        • SimulationOutputEvaluator.__post_init__()
        • SimulationOutputEvaluator.run()
        • SimulationOutputEvaluator._get_data()
        • SimulationOutputEvaluator._get_ref_data()
        • SimulationOutputEvaluator._resampled()
        • SimulationOutputEvaluator._apply_post_treatments()
        • SimulationOutputEvaluator._apply_test()
        • SimulationOutputEvaluator._create_plot()
        • SimulationOutputEvaluator._add_structure_plot()
        • SimulationOutputEvaluator._add_a_value_plot()
        • SimulationOutputEvaluator._add_a_limit_plot()
        • SimulationOutputEvaluator._save_plot()
        • SimulationOutputEvaluator.__init__()
        • SimulationOutputEvaluator._abc_impl
      • _descriptor()
      • _post_treaters()
      • kwargs()

Submodules

• helper module
  • need_to_resample()
  • return_value_should_be_plotted()
  • limits_given_in_functoolspartial_args()
• list_of_simulation_output_evaluators module
  • ListOfSimulationOutputEvaluators
    • ListOfSimulationOutputEvaluators.__init__()
    • ListOfSimulationOutputEvaluators.run()
    • ListOfSimulationOutputEvaluators._unpack_other_evals()
    • ListOfSimulationOutputEvaluators._set_indexes()
    • ListOfSimulationOutputEvaluators._set_columns()
    • ListOfSimulationOutputEvaluators._get_evaluations()
  • FaultScenarioSimulationOutputEvaluators
    • FaultScenarioSimulationOutputEvaluators.__init__()
    • FaultScenarioSimulationOutputEvaluators._set_evaluation_elements()
    • FaultScenarioSimulationOutputEvaluators._create_simulation_output_evaluators()
    • FaultScenarioSimulationOutputEvaluators.run()
    • FaultScenarioSimulationOutputEvaluators._to_pandas_dataframe()
    • FaultScenarioSimulationOutputEvaluators._format_evaluations()
    • FaultScenarioSimulationOutputEvaluators._output()
• post_treaters module
  • do_nothing()
  • set_first_value_to()
  • difference()
  • relative_difference()
  • rms_error()
  • absolute()
  • scale_by()
  • maximum()
  • minimum()
  • take_last()
  • sum()
• specs module
• testers module
  • value_is_within_limits()
  • value_is_above()
  • value_is_below()
  • value_is()
• types module