gemseo / problems

Show inherited members

disciplines_factory module

Factory to create disciplines.

class gemseo.problems.disciplines_factory.DisciplinesFactory[source]

Bases: BaseFactory

The DisciplinesFactory is used to create MDODiscipline objects.

Three types of directories are scanned to import the MDODiscipline classes:

  • the environment variable “GEMSEO_PATH” may contain the list of directories to scan,

  • the present directory (gemseo.problems) contains some benchmark test cases,

Return type:


create(discipline_name, **options)[source]

Create an MDODiscipline from its name.

  • discipline_name (str) – The name of the discipline

  • **options – The options of the discipline, both the options to be passed to the constructor and the options that are generic to all the disciplines.


The discipline.


TypeError – If the class cannot be instantiated.

get_options_grammar(name, write_schema=False, schema_path=None)[source]

Get the options default values for the given class name.

  • name (str) – The name of the class.

  • write_schema (bool) –

    Whether to write the schema files

    By default it is set to False.

  • schema_path (str | None) – the output json file path. If None: input.json or output.json depending on grammar type.


The JSON grammar of the options.

Return type:


property disciplines: list[str]

The names of the available disciplines.

failed_imports: dict[str, str]

The class names bound to the import errors.