gemseo.disciplines.factory module#

A factory of disciplines.

class DisciplineFactory[source]#

Bases: BaseFactory

A factory of disciplines.

Return type:

Any

create(discipline_name, *args, **kwargs)[source]#

Create an Discipline from its name.

Parameters:

  • discipline_name (str) -- The name of the discipline

  • *args (Any) -- The position arguments.

  • **kwargs (Any) -- The keyword arguments, including both the keyword arguments to be passed to the constructor and the keyword arguments that are generic to all the disciplines.

Returns:

The discipline.

Raises:

TypeError -- If the class cannot be instantiated.

Return type:

Discipline

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

Get the options default values for the given class name.

Parameters:

  • 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) --

    the output json file path. If empty: input.json or output.json depending on grammar type.

    By default it is set to "".

Returns:

The JSON grammar of the options.

Return type:

JSONGrammar