https://github.com/whatsopt/xdsmjs
XDSM generator written in javascript.
https://github.com/whatsopt/xdsmjs
multidisciplinary-optimization xdsm
Last synced: 3 months ago
JSON representation
XDSM generator written in javascript.
- Host: GitHub
- URL: https://github.com/whatsopt/xdsmjs
- Owner: whatsopt
- License: apache-2.0
- Created: 2016-03-16T19:30:08.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-06-19T12:00:59.000Z (almost 2 years ago)
- Last Synced: 2025-10-14T20:53:29.739Z (8 months ago)
- Topics: multidisciplinary-optimization, xdsm
- Language: JavaScript
- Homepage:
- Size: 6.55 MB
- Stars: 12
- Watchers: 7
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# XDSMjs
XDSM diagram generator written in javascript.
[](https://github.com/OneraHub/XDSMjs/actions?query=workflow%3ATests)
[](https://app.codacy.com/gh/whatsopt/XDSMjs/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
## XDSM
The XDSM (eXtended Design Structure Matrix) is a notation used to visualize MDO processes.
It was developed by A. B. Lambe and J. R. R. A. Martins, see [MDOLab website dedicated page.](http://mdolab.engin.umich.edu/content/xdsm-overview)
XDSM permissions:
> If you use the XDSM format for research, we ask that you cite the following journal publication in your work:
> A. B. Lambe and J. R. R. A. Martins, “Extensions to the Design Structure Matrix for the Description of Multidisciplinary Design, Analysis, and Optimization Processes”, Structural and Multidisciplinary Optimization, vol. 46, no. 2, p. 273-284, 2012.
## Description
XDSMjs is a javascript generator allowing to display a XDSM diagram within a web page.
It is based on [D3](https://d3js.org/).
It uses the xdsm.json file as input which contains required MDO information to generate the XDSM diagram. See the dedicated Wiki page for a description of the [XDSMjs JSON format](https://github.com/OneraHub/XDSMjs/wiki/XDSMjs-JSON-format).
As of 0.6.0, the MDO data can be specified through data attribute.
As of 0.7.0, XDSMjs supports also [XDSM v2](https://github.com/mdolab/pyXDSM/releases/tag/v2.0). See [Upgrade to 0.7.0 notes](https://github.com/OneraHub/XDSMjs/wiki/Upgrade-to-XDSMjs-0.7.0).
## Citation
If you happen to find XDSMjs useful for research and include diagrams generated with it, it will be appreciated if you cite [the paper which describes the WhatsOpt project that led to XDSMjs development](https://github.com/OneraHub/WhatsOpt#citation)
## Usage
``` bash
> cd /XDSMjs
```
``` bash
> python -m http.server 8020
```
Open `http://localhost:8020/xdsm.html` in the browser.
To see other diagrams, copy a json example from `examples` directory as xdsm.json and reload the page.
As of 0.6.0 version, to use XDSMjs in your web page, you can :
* include the following declarations in your header :
```html
```
* add the place-holder div element that will contain the XDSM diagram :
```html
```
You can either use the attribute data-mdo to specify MDO data in the XDSMjs JSON format in an HTML escaped string
```html
```
or use the attribute data-mdo-file to specify another MDO filename
```html
```
If no data attribute is specified, the default file xdsm.json is expected.
As of 0.7.0, you can use XDSM v2 notation by using xdsm2 class instead of xdsm.
```html
```
As of 0.8.0, you can specify configuration and MDO data directly from the
document.addEventListener('DOMContentLoaded', () => {
let mdo = {nodes: ..., edges: ...}
let config = { labelizer: { showNbLinkOnly: true } };
XDSMjs(config).createXdsm(mdo);
});
## Example
Below an example describing BLISS formulation inspired from XDSM description given in [Martins and Lambe MDO architecture survey](http://arc.aiaa.org/doi/pdf/10.2514/1.J051895). While the formulation could have been described in one diagram as in the survey, the example below use XDSMjs multi-level diagram capability to separate system and discipline optimization levels.
The corresponding [xdsm.json](./examples/bliss.json) file is available in the example directory.
## Licence
Copyright 2020 Rémi Lafage
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.