Skip to content

Commit 063bb41

Browse files
committed
Update citation
1 parent 1b10010 commit 063bb41

2 files changed

Lines changed: 78 additions & 12 deletions

File tree

CITATION.cff

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
cff-version: 1.2.0
2+
title: "Carbonfly: An easy-to-use Python library and Grasshopper toolbox for CO₂-based indoor airflow and air quality CFD simulation"
3+
message: "If you use Carbonfly in your research, please cite the SoftwareX article."
4+
type: software
5+
6+
authors:
7+
- family-names: Huang
8+
given-names: Qirui
9+
10+
doi: 10.5281/zenodo.17117827
11+
repository-code: "https://github.com/RWTH-E3D/carbonfly"
12+
license: "LGPL-3.0"
13+
url: "https://github.com/RWTH-E3D/carbonfly"
14+
15+
preferred-citation:
16+
type: article
17+
title: "Carbonfly: An easy-to-use Python library and Grasshopper toolbox for CO₂-based indoor airflow and air quality CFD simulation"
18+
journal: "SoftwareX"
19+
year: 2026
20+
volume: 34
21+
doi: 10.1016/j.softx.2026.102580
22+
authors:
23+
- family-names: Huang
24+
given-names: Qirui
25+
- family-names: Langenbeck
26+
given-names: Anna
27+
- family-names: Frisch
28+
given-names: Jérôme
29+
- family-names: van Treeck
30+
given-names: Christoph

README.md

Lines changed: 48 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -152,40 +152,76 @@ There are several ways you can contribute:
152152
- 🔧 Submit pull requests to improve the code or documentation
153153
- 📢 Share the plugin with others who may find it useful
154154

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)
156156

157157
[Back to top ↥](#quick-navigation)
158158

159159
## How to cite
160160

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:
162162

163-
- Each release is archived on [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17117827.svg)](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)
164164

165165
**Examples:**
166166

167167
BibTeX:
168168

169169
```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 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17117827.svg)](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,
171192
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},
174195
publisher = {Zenodo},
175196
url = {https://github.com/RWTH-E3D/carbonfly},
176-
note = {{GitHub} repository},
177-
doi = {10.5281/zenodo.17117827}
197+
doi = {10.5281/zenodo.17117827},
178198
}
179199
```
180-
200+
181201
APA style:
182202
```
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
184221
```
185222

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.
187224
188-
Coming soon...
189225

190226
[Back to top ↥](#quick-navigation)
191227

0 commit comments

Comments
 (0)