gemseo.utils package

Utilities: data manipulation, linear solvers and finite differences.

Subpackages

• gemseo.utils.compatibility package
  • Submodules
    • gemseo.utils.compatibility.matplotlib module
      • boxplot()
    • gemseo.utils.compatibility.openturns module
      • create_trend_basis()
    • gemseo.utils.compatibility.scipy module
      • get_row()
• gemseo.utils.derivatives package
  • Submodules
    • gemseo.utils.derivatives.approximation_modes module
      • ApproximationMode
      • HybridApproximationMode
    • gemseo.utils.derivatives.base_gradient_approximator module
      • BaseGradientApproximator
    • gemseo.utils.derivatives.centered_differences module
      • CenteredDifferences
    • gemseo.utils.derivatives.complex_step module
      • ComplexStep
    • gemseo.utils.derivatives.derivatives_approx module
      • DisciplineJacApprox
    • gemseo.utils.derivatives.error_estimators module
      • compute_best_step()
      • compute_cancellation_error()
      • compute_hessian_approximation()
      • compute_truncature_error()
    • gemseo.utils.derivatives.factory module
      • GradientApproximatorFactory
    • gemseo.utils.derivatives.finite_differences module
      • FirstOrderFD
• gemseo.utils.metrics package
  • Submodules
    • gemseo.utils.metrics.base_composite_metric module
      • BaseCompositeMetric
    • gemseo.utils.metrics.base_metric module
      • BaseMetric
    • gemseo.utils.metrics.dataset_metric module
      • DatasetMetric
    • gemseo.utils.metrics.element_wise_metric module
      • ElementWiseMetric
    • gemseo.utils.metrics.mean_metric module
      • MeanMetric
    • gemseo.utils.metrics.metric_factory module
      • MetricFactory
    • gemseo.utils.metrics.squared_error_metric module
      • SquaredErrorMetric
• gemseo.utils.multiprocessing package
  • Submodules
    • gemseo.utils.multiprocessing.execution module
      • execute()
    • gemseo.utils.multiprocessing.manager module
      • get_multi_processing_manager()
• gemseo.utils.n2d3 package
  • Subpackages
    • gemseo.utils.n2d3.css package
    • gemseo.utils.n2d3.js package
  • Submodules
    • gemseo.utils.n2d3.n2_html module
      • N2HTML
    • gemseo.utils.n2d3.n2_json module
      • N2JSON
• gemseo.utils.study_analyses package
  • Submodules
    • gemseo.utils.study_analyses.coupling_study_analysis module
      • CouplingStudyAnalysis
    • gemseo.utils.study_analyses.mdo_study_analysis module
      • MDOStudyAnalysis
    • gemseo.utils.study_analyses.study_analysis_cli module
      • main()
      • parse_args()
      • STUDY_ANALYSIS_TYPES
    • gemseo.utils.study_analyses.xls_study_parser module
      • XLSStudyParser
• gemseo.utils.testing package
  • Submodules
    • gemseo.utils.testing.bilevel_test_helper module
      • create_aerostructure_scenario()
      • create_dummy_bilevel_scenario()
      • create_sobieski_bilevel_bcd_scenario()
      • create_sobieski_bilevel_scenario()
      • create_sobieski_sub_scenarios()
    • gemseo.utils.testing.disciplines_creator module
      • create_disciplines_from_desc()
    • gemseo.utils.testing.helpers module
      • do_not_raise
      • concretize_classes()
      • image_comparison()
    • gemseo.utils.testing.mocks module
      • SleepingCounter
    • gemseo.utils.testing.opt_lib_test_base module
      • OptLibraryTestBase
    • gemseo.utils.testing.pytest_conftest module
      • baseline_images()
      • disable_fault_handler()
      • enable_discipline_statistics()
      • enable_discipline_status()
      • enable_function_statistics()
      • import_or_skip_xlwings()
      • is_xlwings_usable()
      • module_tmp_wd()
      • original_image_directories()
      • pytest_sessionfinish()
      • pytest_sessionstart()
      • reset_factory()
      • skip_if_xlwings_is_not_usable()
      • skip_if_xlwings_is_usable()
      • skip_under_windows()
      • tmp_wd()
• gemseo.utils.xdsm package
  • Submodules
    • gemseo.utils.xdsm.xdsm module
      • XDSM
    • gemseo.utils.xdsm.xdsm_to_pdf module
      • XDSMToPDFConverter
      • xdsm_data_to_pdf()
    • gemseo.utils.xdsm.xdsmizer module
      • XDSMizer
      • expand()

Submodules

• gemseo.utils.base_multiton module
  • BaseABCMultiton
  • BaseMultiton
    • BaseMultiton.clear_cache()
• gemseo.utils.base_name_generator module
  • BaseNameGenerator
    • BaseNameGenerator.Naming
      • BaseNameGenerator.Naming.DATED_UUID
      • BaseNameGenerator.Naming.NUMBERED
      • BaseNameGenerator.Naming.UUID
• gemseo.utils.comparisons module
  • compare_dict_of_arrays()
• gemseo.utils.constants module
  • C_LONG_MAX
  • N_CPUS
  • READ_ONLY_EMPTY_DICT
  • SETTINGS
• gemseo.utils.data_conversion module
  • concatenate_dict_of_arrays_to_array()
  • deepcopy_dict_of_arrays()
  • flatten_nested_bilevel_dict()
  • flatten_nested_dict()
  • nest_flat_bilevel_dict()
  • nest_flat_dict()
  • split_array_to_dict_of_arrays()
• gemseo.utils.deserialize_and_run module
  • main()
• gemseo.utils.directory_creator module
  • DirectoryCreator
    • DirectoryCreator.create()
    • DirectoryCreator.last_directory
• gemseo.utils.discipline module
  • DisciplineVariableProperties
    • DisciplineVariableProperties.current_name
    • DisciplineVariableProperties.current_name_without_namespace
    • DisciplineVariableProperties.description
    • DisciplineVariableProperties.original_name
  • DummyBaseDiscipline
    • DummyBaseDiscipline.cache
    • DummyBaseDiscipline.execution_statistics
    • DummyBaseDiscipline.execution_status
    • DummyBaseDiscipline.name
  • DummyDiscipline
    • DummyDiscipline.cache
    • DummyDiscipline.execution_statistics
    • DummyDiscipline.execution_status
    • DummyDiscipline.jac
    • DummyDiscipline.name
  • VariableRenamer
    • VariableRenamer.from_csv()
    • VariableRenamer.from_dictionary()
    • VariableRenamer.from_spreadsheet()
    • VariableRenamer.from_translations()
    • VariableRenamer.add_translation()
    • VariableRenamer.add_translations_by_discipline()
    • VariableRenamer.add_translations_by_variable()
    • VariableRenamer.translations
    • VariableRenamer.translators
  • VariableTranslation
    • VariableTranslation.discipline_name
    • VariableTranslation.new_variable_name
    • VariableTranslation.variable_name
  • check_disciplines_consistency()
  • get_all_inputs()
  • get_all_outputs()
  • get_discipline_variable_properties()
  • get_sub_disciplines()
  • rename_discipline_variables()
  • update_default_input_values()
• gemseo.utils.enumeration module
  • merge_enums()
• gemseo.utils.file_path_manager module
  • FileDefinition
    • FileDefinition.extension
    • FileDefinition.name
  • FilePathManager
    • FilePathManager.FileType
      • FilePathManager.FileType.FIGURE
      • FilePathManager.FileType.SCHEMA
      • FilePathManager.FileType.TEXT
      • FilePathManager.FileType.WEBPAGE
    • FilePathManager.add_suffix()
    • FilePathManager.to_snake_case()
    • FilePathManager.create_file_path()
• gemseo.utils.ggobi_export module
  • prettify()
  • save_data_arrays_to_xml()
• gemseo.utils.global_configuration module
  • GlobalConfiguration
    • GlobalConfiguration.check_desvars_bounds
    • GlobalConfiguration.enable_discipline_cache
    • GlobalConfiguration.enable_discipline_statistics
    • GlobalConfiguration.enable_discipline_status
    • GlobalConfiguration.enable_function_statistics
    • GlobalConfiguration.enable_parallel_execution
    • GlobalConfiguration.enable_progress_bar
    • GlobalConfiguration.fast
    • GlobalConfiguration.logging
    • GlobalConfiguration.validate_input_data
    • GlobalConfiguration.validate_output_data
• gemseo.utils.hdf5 module
  • convert_h5_group_to_dict()
  • get_hdf5_group()
  • store_attr_h5data()
  • store_h5data()
• gemseo.utils.locks module
  • synchronized()
  • synchronized_hashes()
• gemseo.utils.logging module
  • LoggingConfiguration
    • LoggingConfiguration.date_format
    • LoggingConfiguration.enable
    • LoggingConfiguration.file_mode
    • LoggingConfiguration.file_path
    • LoggingConfiguration.level
    • LoggingConfiguration.message_format
  • LoggingContext
    • LoggingContext.close
    • LoggingContext.handler
    • LoggingContext.level
    • LoggingContext.logger
  • LoggingSettings
    • LoggingSettings.date_format
    • LoggingSettings.logger
    • LoggingSettings.message_format
  • MultiLineFileHandler
  • MultiLineHandlerMixin
    • MultiLineHandlerMixin.emit()
  • MultiLineStreamHandler
  • OneLineLogging
  • DEFAULT_DATE_FORMAT
  • DEFAULT_MESSAGE_FORMAT
  • GEMSEO_LOGGER
  • LOGGING_SETTINGS
• gemseo.utils.logging_tools module
• gemseo.utils.matplotlib_figure module
  • save_show_figure()
  • save_show_figure_from_file_path_manager()
  • show_close_figures()
  • FigSizeType
• gemseo.utils.metaclasses module
  • ABCGoogleDocstringInheritanceMeta
• gemseo.utils.name_generator module
  • NameGenerator
    • NameGenerator.generate_name()
• gemseo.utils.pickle module
  • from_pickle()
  • to_pickle()
• gemseo.utils.platform module
• gemseo.utils.portable_path module
  • to_os_specific()
• gemseo.utils.pydantic module
  • copy_field()
  • create_model()
  • get_algo_name()
  • get_class_name()
  • update_field()
• gemseo.utils.pydantic_ndarray module
• gemseo.utils.repr_html module
  • REPR_HTML_WRAPPER
• gemseo.utils.seeder module
  • Seeder
    • Seeder.get_seed()
    • Seeder.default_seed
  • SEED
• gemseo.utils.show_utils module
  • generate_xdsm_html()
• gemseo.utils.singleton module
  • SingleInstancePerAttributeId
    • SingleInstancePerAttributeId.instances
  • SingleInstancePerFileAttribute
    • SingleInstancePerFileAttribute.instances
• gemseo.utils.source_parsing module
  • get_callable_argument_defaults()
  • get_options_doc()
  • get_return_description()
  • parse_google()
• gemseo.utils.string_tools module
  • MessageLine
    • MessageLine.args
    • MessageLine.kwargs
    • MessageLine.level
    • MessageLine.str_format
  • MultiLineString
    • MultiLineString.offset()
    • MultiLineString.add()
    • MultiLineString.dedent()
    • MultiLineString.indent()
    • MultiLineString.replace()
    • MultiLineString.reset()
    • MultiLineString.DEFAULT_LEVEL
    • MultiLineString.INDENTATION
    • MultiLineString.lines
  • convert_strings_to_iterable()
  • filter_names()
  • get_name_and_component()
  • get_variables_with_components()
  • pretty_repr()
  • pretty_str()
  • repr_variable()
  • DEFAULT_DELIMITER
  • DEFAULT_KEY_VALUE_SEPARATOR
• gemseo.utils.timer module
  • Timer
    • Timer.elapsed_time
    • Timer.entering_timestamp
    • Timer.exiting_timestamp
• gemseo.utils.xdsm_to_pdf module
• gemseo.utils.xdsmizer module