Generate an N2 and XDSM from an Excel description of the MDO problem

from os import mkdir
from os.path import exists
from os.path import join

from gemseo.api import configure_logger
from gemseo.utils.study_analysis import StudyAnalysis

configure_logger()

Out:

<RootLogger root (INFO)>

Describe your MDO problem in an Excel file

../../_images/disciplines_spec.png

Visualize this study

study = StudyAnalysis("disciplines_spec.xlsx")
if not exists("outputs"):
    mkdir("outputs")

Out:

INFO - 13:07:24: Detected the following disciplines: ['Discipline1', 'Discipline2', 'Scenario']
INFO - 13:07:24: Parsing discipline Discipline1
INFO - 13:07:24: Inputs: ['a', 'b', 'c']
INFO - 13:07:24: Outputs: ['d', 'e', 'g']
INFO - 13:07:24: Parsing discipline Discipline2
INFO - 13:07:24: Inputs: ['z', 'x', 'd', 'g']
INFO - 13:07:24: Outputs: ['a', 'b', 'f']
INFO - 13:07:24: Detected scenario in sheet: Scenario
INFO - 13:07:24: New scenario: Scenario
INFO - 13:07:24: Objectives: ['f']
INFO - 13:07:24: Disciplines: ['Discipline1', 'Discipline2']
INFO - 13:07:24: Constraints: ['g']
INFO - 13:07:24: Design variables: ['b', 'x']
INFO - 13:07:24: Formulation: MDF

Generate N2 chrt

study.generate_n2(file_path=join("outputs", "n2.png"), save=False, show=True)
plot study prototyping

Generate XDSM

study.generate_xdsm("outputs")

Out:

    INFO - 13:07:24: Generated the following Scenario:
    INFO - 13:07:24: MDOScenario
    INFO - 13:07:24: Optimization problem:
    INFO - 13:07:24:    minimize f(x)
    INFO - 13:07:24:    with respect to x
    INFO - 13:07:24:    subject to constraints:
    INFO - 13:07:24:       g(x) == 0.0
    INFO - 13:07:24: Generating HTML XDSM file in : outputs/xdsm.html

MDOScenario
   Disciplines: Discipline1 Discipline2
   MDO formulation: MDF
../../_images/xdsm.png

Visualize this study from command line

We can create the same figures using command line inputs:

gemseo-study disciplines_spec.xlsx -o outputs -s '(5,5)' -x -l

where:

  • gemseo-study is an executable provided by GEMSEO,

  • disciplines_spec.xlsx is the Excel file path,

  • -o outputs is the output directory,

  • -s '(5,5)' is the size of the N2 chart,

  • -x is an option to create of the XDSM,

  • -l is an option to create a PDF file with the creation of the XDSM.

Total running time of the script: ( 0 minutes 0.332 seconds)

Gallery generated by Sphinx-Gallery