Excel file parser for the study analyses.
- class gemseo.utils.study_analyses.xls_study_parser.XLSStudyParser(xls_study_path, has_scenario=True)¶
A study specification based on an Excel file.
The Excel file shall contain one sheet per discipline:
the name of the sheet shall have the discipline name,
the sheet shall define the input names of the discipline as a vertical succession of cells starting with
the sheet shall define the output names of the discipline as a vertical succession of cells starting with
the empty lines of the series
the sheet may contain other data, but these will not be taken into account.
True, the Excel file shall contain one sheet per scenario with a name starting by
Scenario. Distributed formulations shall contain one sheet for the main scenario and one sheet per sub-scenario.
A scenario sheet shall have the following columns:
These columns must satisfy some constraints:
all of them are mandatory, even if empty for the constraints,
their order does not matter,
one and only one formulation must be declared,
at least one objective must be provided,
at least one design variable must be provided,
all the objective functions and constraints must be outputs of a discipline, not necessarily the one of the current sheet,
all the design variables must be inputs of a discipline, not necessarily the one of the current sheet.
Options valuesare used to pass the formulation options. Note that for string type
Option values, the value can be written with or without the
To use multi-level MDO formulations, create multiple scenarios, and add the name of the sub-scenarios in the list of disciplines of the main (system) scenario.
An arbitrary number of levels can be generated this way (three, four, …, n, level formulations).