Metadata-Version: 2.4
Name: pyXDSM
Version: 2.3.2
Summary: Python script to generate PDF XDSM diagrams using TikZ and LaTeX
Home-page: https://github.com/mdolab/pyXDSM
Author: 
Author-email: 
License: Apache License Version 2.0
Keywords: optimization multidisciplinary multi-disciplinary analysis n2 xdsm
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: numpy>=1.25
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# pyXDSM
[![Build Status](https://github.com/mdolab/pyXDSM/actions/workflows/test.yaml/badge.svg)](https://github.com/mdolab/pyXDSM/actions/workflows/test.yaml)
[![Documentation Status](https://readthedocs.com/projects/mdolab-pyxdsm/badge/?version=latest)](https://mdolab-pyxdsm.readthedocs-hosted.com/?badge=latest)
[![PyPI](https://img.shields.io/pypi/v/pyxdsm)](https://pypi.org/project/pyXDSM/)
![PyPI - Downloads](https://img.shields.io/pypi/dm/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.

# Documentation

Please see the [documentation](https://mdolab-pyxdsm.readthedocs-hosted.com) for installation details and API documentation.

To locally build the documentation, enter the `doc` folder and enter `make html` in the terminal.
You can then view the built documentation in the `_build` folder.

### XDSM diagram
![XDSM of MDF](doc/images/mdf.png)

### Block matrix equation
![Block matrix equation](doc/images/matrix_eqn.png)

## Citation
Please cite the [paper by Lambe and Martins](http://mdolab.engin.umich.edu/bibliography/Lambe2012a.html) when using XDSM.
Here is the bibtex entry 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}
    }
