# pyXDSM Release 2.1.2

Python script to generate PDF XDSM diagrams using TikZ and LaTeX

Keywords
optimization, multidisciplinary, multi-disciplinary, analysis, n2, xdsm
Apache-2.0
Install
 pip install pyXDSM==2.1.2 

# pyXDSM

A python library for generating publication quality PDF XDSM diagrams. This library is a thin wrapper that uses the TikZ library and LaTeX to build the PDFs.

# Installation

This package can be installed using

pip install pyxdsm

Alternatively, clone this repo or download the zip and unzip it.

cd pyxdsm
pip install .

## What is XDSM?

The eXtended Design Structure Matrix (XDSM) is a graphical language for describing the movement of data and the execution sequence for a multidisciplinary optimization problem. You can read the paper by Lambe and Martins for all the details. If you would like a citation for XDSM, here is the bibtex for that paper:

@article {Lambe2012,
title = {Extensions to the Design Structure Matrix for the Description of Multidisciplinary Design, Analysis, and Optimization Processes},
journal = {Structural and Multidisciplinary Optimization},
volume = {46},
year = {2012},
pages = {273-284},
doi = {10.1007/s00158-012-0763-y},
author = {Andrew B. Lambe and Joaquim R. R. A. Martins}
}


## TikZ and LaTeX?

You need to install these libraries for pyXDSM to work. See the install guide for your platform

## How do I use it?

Here is a simple example. There are some other more advanced things you can do as well. Check out the examples folder

from pyxdsm.XDSM import XDSM

opt = 'Optimization'
solver = 'MDA'
func = 'Function'

x = XDSM()

x.connect('opt', 'D1', 'x, z')
x.connect('opt', 'D2', 'z')
x.connect('opt', 'F', 'x, z')
x.connect('solver', 'D1', 'y_2')
x.connect('solver', 'D2', 'y_1')
x.connect('D1', 'solver', r'\mathcal{R}(y_1)')
x.connect('solver', 'F', 'y_1, y_2')
x.connect('D2', 'solver', r'\mathcal{R}(y_2)')
x.connect('solver', 'G', 'y_1, y_2')

x.connect('F', 'opt', 'f')
x.connect('G', 'opt', 'g')

x.add_output('opt', 'x^*, z^*', side='left')
x.write('mdf')

This will output mdf.tex, a standalone tex document that (by default) is also compiled to mdf.pdf.

## More complicated example

Here is an example that uses a whole bunch of the more advanced features in pyXDSM. Its mostly just a reference for all the customizations you can do. The code for this is in the examples folder

## Embedding the diagram directly in LaTeX

In addition, the file, mdf.tikz, can be embedded in another tex file using the \input command:

\begin{figure}
\caption{Example of an MDF XDSM.}
\centering
\input{mdf.tikz}
\label{fig:xdsm}
\end{figure}


The following is required to be in the preamble of the document:

\usepackage{geometry}
\usepackage{amsfonts}
\usepackage{amsmath}
\usepackage{amssymb}
\usepackage{tikz}