How to cite eppy?

[airallergy]

Not sure if this has been asked before, a quick search did not find anything, how would you like eppy to be cited? eppy is very well deserved to be properly cited in papers and reports, and it would be ideal to have a consistent way to do so. (I came across a few papers citing eppy, but unsurprisingly fairly diverged.)

Zonodo seems popular to get a doi for software, as mentioned in this GitHub doc. A few alternatives exist I think. Also, GitHub added the function to have a CITATION file in the root at some point.

[santoshphilip]

@airallergy , thank you for bringing this to my attention. Citations are not on my radar, since I am not in the academic universe :-).

the links you have given are very informative. I'll probably pick one of them. I'll bounce my thinking on it off you before I implement.

I do recollect seeing a note on citations for the CBE Termal comfort tool. It is at the bottom of the page. They have a paper associated with the too. so it is easier to cite.

There are two papers on eppy (I am an author on one of them) that may be worth linking too.

I'll leave this issue open until it comes to a conclusion

[airallergy]

I wasn't aware that there are papers on eppy, could you share some links?

If there exists a paper specific about eppy authored by you, I think it is a common practice to cite that, which is the case for the thermal comfort tool you mentioned, also for numpy, SciPy, etc. Otherwise (I found this for example), I am not sure to be honest.

[santoshphilip]

Yes that is the link of the paper on eppy as a tool.

eppy was partly funded by a project that @jasonglazer did for ASHRAE. He published one or two papers on the project.

Jason sent me some links long ago on other papers that mention eppy:

Paper referencing Eppy

I just came across this

https://www.sciencedirect.com/science/article/abs/pii/S0306261921007492?via%3Dihub

Maybe it is not that uncommon

https://scholar.google.com/scholar?hl=en&as_sdt=0%2C24&q=energyplus+eppy&btnG=

Jason

[JasonGlazer]

The paper I wrote as part of the ASHRAE 1651-RP project related to eppy was:

https://publications.ibpsa.org/conference/paper/?id=simbuild2016_C030

In it I cited eppy by using:

I didn't notice the typo but I think it was intended to say "Eppy scripting language for EnergyPlus idf files and EnergyPlus output files."

[airallergy]

Citing these existing papers mentioning eppy now seems less ideal, as they cited eppy themselves, one way or another :)

I suppose it boils down to two options for a standardised/recommended eppy citation:

1. write a manual entry for the CITATION file
2. create a Zonodo, or alike, entry and include it in the CITATION file

[santoshphilip]

@airallergy , I agree. I'll just pick one of them and go with it. Will close this issue once that happens