Skip to content

Commit 359f02c

Browse files
committed
Updated README to describe instigator feature
1 parent 189c5dd commit 359f02c

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Change Propagation Library
1+
# Change Prediction Library
22
This library is intended to assist in the calculation of
3-
change propagation (Clarkson et al., 2004) in a system.
3+
change prediction/propagation (Clarkson et al., 2004) in a system.
44
The library takes to DSMs as an input: one for likelihoods and
55
one for impacts. These DSMs should be in a CSV format.
66
Once the DSMs are loaded, a `ChangePropagationTree` can be
@@ -104,6 +104,20 @@ between C and B is bi-directional, while change can also propagate from D to C.
104104
| **C** | | 0.5 | C | 0.5 |
105105
| **D** | | | | D |
106106

107+
## Changing DSM directionality
108+
If it is desirable to instead have instigation occur from rows to columns,
109+
then it is possible to instantiate the DSMs with this as a keyword attribute:
110+
```
111+
dsm = DSM(matrix=data, columns=column_names, instigator="row")
112+
```
113+
The default is `instigator='column`.
114+
This can also be utilized when parsing a CSV-file, like this:
115+
116+
```
117+
dsm = parse_csv(filepath, instigator='row')
118+
```
119+
120+
Note that changing instigator will completely change the results of propagation.
107121

108122
## References
109123
Clarkson, P. J., Caroline, S., & Claudia, E. (2004). Predicting Change Propagation in Complex Design. Journal of Mechanical Design, 126(5), 788–797. https://doi.org/10.1115/1.1765117

0 commit comments

Comments
 (0)