You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+48-12Lines changed: 48 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -152,40 +152,76 @@ There are several ways you can contribute:
152
152
- 🔧 Submit pull requests to improve the code or documentation
153
153
- 📢 Share the plugin with others who may find it useful
154
154
155
-
Copyright (C) 2025 Qirui Huang, [Institute of Energy Efficiency and Sustainable Building (E3D), RWTH Aachen University](https://www.e3d.rwth-aachen.de/go/id/iyld/?lidx=1)
155
+
Copyright (C) 2026 Qirui Huang, [Institute of Energy Efficiency and Sustainable Building (E3D), RWTH Aachen University](https://www.e3d.rwth-aachen.de/go/id/iyld/?lidx=1)
156
156
157
157
[Back to top ↥](#quick-navigation)
158
158
159
159
## How to cite
160
160
161
-
If you want to cite **Carbonfly** in your academic work, there are two ways to do it:
161
+
If you want to cite **Carbonfly**, there are two ways to do it:
162
162
163
-
-Each release is archived on [](https://doi.org/10.5281/zenodo.17117827). Please either cite the version you used as indexed at Zenodo (for reproducibility) or cite all versions.
163
+
-If you use Carbonfly in your academic work, please cite our journal paper: https://doi.org/10.1016/j.softx.2026.102580 (preferred)
164
164
165
165
**Examples:**
166
166
167
167
BibTeX:
168
168
169
169
```bibtex
170
-
@software{Carbonfly_Huang,
170
+
@article{Huang_2026_Carbonfly_SoftwareX,
171
+
author = {Huang, Qirui and Langenbeck, Anna and Frisch, J{\'e}r{\^o}me and van Treeck, Christoph},
172
+
title = {{Carbonfly}: {An} easy-to-use {Python} library and {Grasshopper} toolbox for {CO}$_2$-based indoor airflow and air quality {CFD} simulation},
173
+
journal = {SoftwareX},
174
+
year = {2026},
175
+
pages = {102580},
176
+
doi = {10.1016/j.softx.2026.102580},
177
+
}
178
+
```
179
+
180
+
APA style:
181
+
```
182
+
Huang, Q., Langenbeck, A., Frisch, J., & van Treeck, C. (2026). Carbonfly: An easy-to-use Python library and Grasshopper toolbox for CO₂-based indoor airflow and air quality CFD simulation. SoftwareX, 102580. https://doi.org/10.1016/j.softx.2026.102580
183
+
```
184
+
185
+
- If your work depends on a specific release of Carbonfly, please additionally cite the archived Zenodo version corresponding to the release you used. Each release is archived on [](https://doi.org/10.5281/zenodo.17117827). Please either cite the version you used as indexed at Zenodo (for reproducibility) or cite all versions.
186
+
187
+
**Examples:**
188
+
189
+
BibTeX:
190
+
```bibtex
191
+
@misc{Carbonfly_Zenodo_Huang,
171
192
author = {Qirui Huang},
172
-
title = {Carbonfly: An easy-to-use {Python} library and {Grasshopper} toolbox for indoor {CO2} {CFD} simulation},
173
-
date = {2025},
193
+
title = {{Carbonfly}: {An} easy-to-use {Python} library and {Grasshopper} toolbox for {CO}$_2$-based indoor airflow and air quality {CFD} simulation},
194
+
year = {2025},
174
195
publisher = {Zenodo},
175
196
url = {https://github.com/RWTH-E3D/carbonfly},
176
-
note = {{GitHub} repository},
177
-
doi = {10.5281/zenodo.17117827}
197
+
doi = {10.5281/zenodo.17117827},
178
198
}
179
199
```
180
-
200
+
181
201
APA style:
182
202
```
183
-
Huang, Q. (2025). Carbonfly: An easy-to-use Python library and Grasshopper toolbox for indoor CO2 CFD simulation [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.17117827
203
+
Huang, Q. (2025). Carbonfly: An easy-to-use Python library and Grasshopper toolbox for CO₂-based indoor airflow and air quality CFD simulation [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.17117827
204
+
```
205
+
206
+
BibTeX (version-specific):
207
+
```bibtex
208
+
@misc{Carbonfly_Zenodo_Huang,
209
+
author = {Qirui Huang},
210
+
title = {{Carbonfly}: {An} easy-to-use {Python} library and {Grasshopper} toolbox for {CO}$_2$-based indoor airflow and air quality {CFD} simulation (Version v0.8.0)},
211
+
year = {2025},
212
+
note = {Zenodo}
213
+
url = {https://doi.org/10.5281/zenodo.17504360},
214
+
doi = {10.5281/zenodo.17504360},
215
+
}
216
+
```
217
+
218
+
APA style (version-specific):
219
+
```
220
+
Huang, Q. (2025). Carbonfly: An easy-to-use Python library and Grasshopper toolbox for CO₂-based indoor airflow and air quality CFD simulation (Version 0.8.0) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.17504360
184
221
```
185
222
186
-
- If you wish to cite **Carbonfly** for its design, methodology, etc. (rather than a specific release), please cite our paper:
223
+
> ⚠️ Replace the version and DOI with those of the exact release you used.
0 commit comments