API Reference

API Reference

• Parameter Module
  • Parameter
    • Parameter.name
    • Parameter.interval
    • Parameter.values
    • Parameter.ptype
    • Parameter.relabs
    • Parameter.init_value
    • Parameter.min_max_interval
    • Parameter.model_property
    • Parameter.__init__()
• Model Module
  • Model
    • Model.get_property_from_param()
    • Model.simulate()
    • Model.simulate_parameter()
    • Model.get_property_values()
    • Model.save()
    • Model.__init__()
    • Model.get_property_from_param()
    • Model.simulate()
    • Model.simulate_parameter()
    • Model.get_property_values()
    • Model.save()
• Sampling Module
  • Sample
    • Sample.parameters
    • Sample.is_dynamic
    • Sample.values
    • Sample.results
    • Sample.get_pending_index()
    • Sample.get_parameters_intervals()
    • Sample.get_list_parameter_value_pairs()
    • Sample.get_dimension_less_values()
    • Sample.add_samples()
    • Sample.get_aggregated_time_series()
    • Sample.get_static_results_as_df()
    • Sample.get_score_df()
    • Sample.plot_hist()
    • Sample.plot_sample()
    • Sample.plot_pcp()
    • Sample.__init__()
  • Sampler
    • Sampler.__init__()
    • Sampler.parameters
    • Sampler.values
    • Sampler.results
    • Sampler.add_sample()
    • Sampler.append_sample_from_param_dict()
    • Sampler.simulate_at()
    • Sampler.simulate_pending()
  • RealSampler
    • RealSampler.get_salib_problem()
    • RealSampler.__init__()
    • RealSampler.get_salib_problem()
  • MorrisSampler
    • MorrisSampler.add_sample()
    • MorrisSampler.__init__()
    • MorrisSampler.add_sample()
  • FASTSampler
    • FASTSampler.add_sample()
    • FASTSampler.__init__()
    • FASTSampler.add_sample()
  • RBDFASTSampler
    • RBDFASTSampler.add_sample()
    • RBDFASTSampler.__init__()
    • RBDFASTSampler.add_sample()
  • LHSSampler
    • LHSSampler.add_sample()
    • LHSSampler.__init__()
    • LHSSampler.add_sample()
  • SobolSampler
    • SobolSampler.__init__()
    • SobolSampler.add_sample()
• Sensitivity Module
  • Sanalysis
    • Sanalysis.__init__()
    • Sanalysis.sample
    • Sanalysis.parameters
    • Sanalysis.values
    • Sanalysis.results
    • Sanalysis._set_sampler()
    • Sanalysis.add_sample()
    • Sanalysis.analyze()
    • Sanalysis.salib_plot_bar()
    • Sanalysis.salib_plot_dynamic_metric()
    • Sanalysis.salib_plot_matrix()
  • SobolSanalysis
    • SobolSanalysis.__init__()
    • SobolSanalysis.add_sample()
    • SobolSanalysis.analyze()
    • SobolSanalysis.plot_bar()
    • SobolSanalysis.plot_dynamic_metric()
    • SobolSanalysis.plot_s2_matrix()
  • MorrisSanalysis
    • MorrisSanalysis.__init__()
    • MorrisSanalysis.add_sample()
    • MorrisSanalysis.analyze()
    • MorrisSanalysis.plot_scatter()
    • MorrisSanalysis.plot_bar()
    • MorrisSanalysis.plot_dynamic_metric()
  • FASTSanalysis
    • FASTSanalysis.__init__()
    • FASTSanalysis.add_sample()
    • FASTSanalysis.analyze()
    • FASTSanalysis.plot_bar()
    • FASTSanalysis.plot_dynamic_metric()
  • RBDFASTSanalysis
    • RBDFASTSanalysis.__init__()
    • RBDFASTSanalysis.add_sample()
    • RBDFASTSanalysis.analyze()
    • RBDFASTSanalysis.plot_bar()
    • RBDFASTSanalysis.plot_dynamic_metric()
• Optimize Module
  • SciOptimizer
    • SciOptimizer.__init__()
    • SciOptimizer.parameters
    • SciOptimizer.sample
    • SciOptimizer.values
    • SciOptimizer.results
    • SciOptimizer.scalar_minimize()
    • SciOptimizer.minimize()
    • SciOptimizer.diff_evo_minimize()
  • ModelEvaluator
    • ModelEvaluator.__init__()
    • ModelEvaluator.intervals
    • ModelEvaluator.get_initial_values()
    • ModelEvaluator.evaluate()
    • ModelEvaluator.scipy_obj_function()
    • ModelEvaluator.scipy_scalar_obj_function()
  • RealContinuousProblem
    • RealContinuousProblem._evaluate()
    • RealContinuousProblem.__init__()
  • MixedProblem
    • MixedProblem._evaluate()
    • MixedProblem.__init__()
• Surrogate Module
  • ModelTrainer
    • ModelTrainer.__init__()
    • ModelTrainer.train()
    • ModelTrainer.test_nmbe_score
    • ModelTrainer.test_cvrmse_score
  • MultiModelSO
    • MultiModelSO.fit()
    • MultiModelSO.predict()
    • MultiModelSO.get_model()
    • MultiModelSO.fine_tune()
    • MultiModelSO.__init__()
    • MultiModelSO.feature_names_in_
    • MultiModelSO.fit()
    • MultiModelSO.predict()
    • MultiModelSO.get_model()
    • MultiModelSO.fine_tune()
    • MultiModelSO.get_feature_importance()
    • MultiModelSO.set_fit_request()
    • MultiModelSO.set_predict_request()
    • MultiModelSO.set_score_request()
  • StaticScikitModel
    • StaticScikitModel.__init__()
    • StaticScikitModel.simulate()
• FMU Module
  • ModelicaFmuModel
    • ModelicaFmuModel.__init__()
    • ModelicaFmuModel.get_property_values()
    • ModelicaFmuModel.set_property_values()
    • ModelicaFmuModel.simulate()
    • ModelicaFmuModel.save()
    • ModelicaFmuModel.__repr__()
• Metrics
  • nmbe()
  • cv_rmse()