# 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 of MDF](doc/images/mdf.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}
}
Raw data
{
"_id": null,
"home_page": "https://github.com/mdolab/pyXDSM",
"name": "pyXDSM",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": "",
"keywords": "optimization multidisciplinary multi-disciplinary analysis n2 xdsm",
"author": "",
"author_email": "",
"download_url": "",
"platform": null,
"description": "# pyXDSM\n[![Build Status](https://github.com/mdolab/pyXDSM/actions/workflows/test.yaml/badge.svg)](https://github.com/mdolab/pyXDSM/actions/workflows/test.yaml)\n[![Documentation Status](https://readthedocs.com/projects/mdolab-pyxdsm/badge/?version=latest)](https://mdolab-pyxdsm.readthedocs-hosted.com/?badge=latest)\n[![PyPI](https://img.shields.io/pypi/v/pyxdsm)](https://pypi.org/project/pyXDSM/)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/pyXDSM)\n\nA python library for generating publication quality PDF XDSM diagrams.\nThis library is a thin wrapper that uses the TikZ library and LaTeX to build the PDFs.\n\n# Documentation\n\nPlease see the [documentation](https://mdolab-pyxdsm.readthedocs-hosted.com) for installation details and API documentation.\n\nTo locally build the documentation, enter the `doc` folder and enter `make html` in the terminal. \nYou can then view the built documentation in the `_build` folder.\n\n![XDSM of MDF](doc/images/mdf.png)\n\n\n\n## Citation\nPlease cite the [paper by Lambe and Martins](http://mdolab.engin.umich.edu/bibliography/Lambe2012a.html) when using XDSM.\nHere is the bibtex entry for that paper:\n\n @article {Lambe2012,\n title = {Extensions to the Design Structure Matrix for the Description of Multidisciplinary Design, Analysis, and Optimization Processes},\n journal = {Structural and Multidisciplinary Optimization},\n volume = {46},\n year = {2012},\n pages = {273-284},\n doi = {10.1007/s00158-012-0763-y},\n author = {Andrew B. Lambe and Joaquim R. R. A. Martins}\n }\n\n\n\n",
"bugtrack_url": null,
"license": "Apache License Version 2.0",
"summary": "Python script to generate PDF XDSM diagrams using TikZ and LaTeX",
"version": "2.3.0",
"project_urls": {
"Homepage": "https://github.com/mdolab/pyXDSM"
},
"split_keywords": [
"optimization",
"multidisciplinary",
"multi-disciplinary",
"analysis",
"n2",
"xdsm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1e9371241cd83c3c5c1488d9238580e2b0ce5a83b0b12c7f41c3dfe94122ddaa",
"md5": "45b998d221ec1f1275fb51795374f5b3",
"sha256": "895f1a038a2723fceb323afd97a44a25a87606c2226ccf9f8ffa983d7253444b"
},
"downloads": -1,
"filename": "pyXDSM-2.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "45b998d221ec1f1275fb51795374f5b3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 15329,
"upload_time": "2023-05-17T17:31:44",
"upload_time_iso_8601": "2023-05-17T17:31:44.568640Z",
"url": "https://files.pythonhosted.org/packages/1e/93/71241cd83c3c5c1488d9238580e2b0ce5a83b0b12c7f41c3dfe94122ddaa/pyXDSM-2.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-17 17:31:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mdolab",
"github_project": "pyXDSM",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pyxdsm"
}