Skip to content

Commit cb5ba19

Browse files
authored
Add README
Added supplementary material and data organization details for the study on choice-based engineering design optimization.
1 parent 3e16329 commit cb5ba19

1 file changed

Lines changed: 91 additions & 0 deletions

File tree

README.md

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Supplementary material (results): "Choice-based engineering design optimization: a comparative analysis with conventional cost minimization applied to the design of a fuel cell micro cogeneration system"
2+
3+
This repository contains supplementary material for the study:
4+
> Choice-based engineering design optimization: a comparative analysis with conventional cost minimization
5+
applied to the design of a fuel cell micro-cogeneration system Marvin Meck, PhD thesis (under review), TU Darmstadt, 2026
6+
7+
It includes intermediate and final results, as well as supporting data used to generate the findings reported in the study.
8+
9+
The repository provides:
10+
* Intermediate data used during modelling and analysis
11+
* Final results underlying figures and tables
12+
* Data used to create supplementary figures and tables
13+
14+
All data are stored in text-based formats to ensure long-term accessibility:
15+
`.csv` for tabular data
16+
`.json` / `.yaml` for structured data
17+
`AMPL` / `Pyomo` data formats for optimization model data
18+
19+
## Data identification and organization
20+
21+
Inspired by [Müller (2022)](#References) and [Hock et al. (2023)](#References),
22+
the data generated during this research project are systematically organized using a structured identification scheme.
23+
Each dataset consists of one or multiple files and is assigned a unique 3-tuple of integers of the form:
24+
```
25+
(DataType, Chapter, Counter)
26+
```
27+
28+
To produce a compact and readable identifier for use in file names and references, each `(DataType, Chapter, Counter)` tuple is encoded using the [`sqids`](https://sqids.org) algorithm.
29+
[`Sqids`](https://sqids.org) converts the three-integer tuple into a short, unique, non-sequential string identifier.
30+
For example:
31+
* The tuple `(0, 3, 1)` might become `gVHrJE`, and
32+
* the tuple `(1, 3, 1)` might become `fG9gW1`.
33+
34+
The components of the tuple identifying the datasets are defined as follows.
35+
`DataType` indicates the type of the data, and is defined to take the following values:
36+
* `0` - Support: Intermediate or supporting data used in modelling or analysis, but not directly associated with any particular figure or table.
37+
* `1` - Figure: Data used to produce figures.
38+
* `2` — Table: Data used to generate tables.
39+
40+
`Chapter` indicates the chapter in which the data is used or discussed,
41+
numbered as:
42+
* `1` — Introduction
43+
* `2` — Literature Review
44+
* `3` — Methods
45+
* `4` — Results
46+
* `5` — Discussion
47+
* `6` — Conclusion
48+
* `7` — Appendix
49+
50+
Lastly, `Counter` is an integer value incremented for datasets of the same type within the same chapter.
51+
52+
### Metadata
53+
54+
Where necessary, files include metadata to support interpretation and reproducibility.
55+
This may include:
56+
* parameter values
57+
* references to other datasets
58+
* software version information
59+
* modelling assumptions
60+
* data provenance (e.g. external sources)
61+
62+
Metadata are stored either:
63+
* directly within files (e.g. comments in .csv, fields in .json/.yaml)
64+
* or in accompanying text files
65+
66+
## Reproducibility
67+
68+
All results in this repository are designed to be reproducible using the provided data and associated research code.
69+
Some datasets rely on third-party data sources.
70+
These are archived within TU Darmstadt's institutional research data repository TUdatalib but not publicly redistributed due to licensing restrictions.
71+
Access must be obtained from the respective rights holders; see ([here]((https://tudatalib.ulb.tu-darmstadt.de/handle/tudatalib/5082))).
72+
73+
## Usage
74+
75+
Licensed under the Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0) license.
76+
See: https://creativecommons.org/licenses/by-nc/4.0/
77+
78+
If you use this material, please cite:
79+
80+
> Meck, Marvin (2026), "Choice-based engineering design optimization: a comparative analysis with conventional cost
81+
minimization applied to the design of a fuel cell micro cogeneration system", PhD thesis (in preparation), TU Darmstadt.
82+
83+
## References
84+
85+
Müller, T.M. (2022) Algorithmisch gestützte Planung dezentraler Fluidsysteme. UNSPECIFIED. Available at: https://doi.org/10.26083/TUPRINTS-00021608.
86+
87+
Hock, M. et al. (2023) “plotID - a toolkit for connecting research data and visualization,” ing.grid, 1(1). Available at: https://doi.org/10.48694/INGGRID.3632.
88+
89+
## Contact
90+
91+
For questions or data access inquiries, please open an issue or contact the author.

0 commit comments

Comments
 (0)