gperonato / ghcitysim

Set of Grasshopper components for interfacing with CitySim. ©2016-2018 EPFL-LIPID

GHCitySim

Set of Grasshopper components for interfacing with CitySim, an urban-scale building energy simulation tool.

GHCitySim requires Ladybug and Honeybee legacy plugins (as well as GHPython if you are using Rhino 5) to be installed. A copy of the components from Ladybug and Honeybee needed to run GHCitySim is contained in this repository.

The GHCitySim components are saved both as compiled GH components (/userObjects) and source code (/src). To install, just drag and drop the files in the /UserObjects directory onto the Grasshopper canvas.

In the resources folder you will find:

• two *.ghx files containing sample Grasshopper definitions where the components are used; the *_solar.ghx file contains an alternative workflow for solar simulations only, which does not rely on Ladybug/Honeybee libraries.
• a sample weather file in EnergyPlus format *.epw converted in CitySim format *.cli;

The simulation output files for the two sample workflows (test and test_solar) are saved in the /simulation directory.

About CitySim

CitySim is a software developed and distributed by the Laboratory of Solar Energy and Building Physics (LESO-PB) of the Ecole polytechnique fédérale de Lausanne (EPFL). The CitySim Solver can be downloaded from here.

Citation

GHCitySim is free to use. You are kindly invited to acknowledge its use by citing it in a research paper you are writing, reports, and/or other applicable materials. Please cite the following paper (PDF):

@inproceedings{peronato_integrating_2017,
	address = {Edinburgh},
	title = {Integrating urban energy simulation in a parametric environment:
	a {Grasshopper} interface for {CitySim}},
	url = {https://infoscience.epfl.ch/record/228832?ln=en},
	booktitle = {Proceedings of {PLEA} 2017},
	author = {Peronato, Giuseppe and Kämpf, Jérôme and Rey, Emmanuel and Andersen, Marilyne},
	year = {2017}
}

License

GHCitySim: set of Grasshopper components for interfacing with CitySim, started by Giuseppe Peronato
Copyright (c) 2016-2018, Ecole polytechnique fédérale de Lausanne (EPFL)
Laboratory of Integrated Performance in Design (LIPID)

Further development conducted at Uppsala University, Sweden
Division of Construction Engineering, 2019
Developer: Giuseppe Peronato, giuseppe.peronato[at]angstrom.uu.se

GHCitySim is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

GHCitySim is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with GHCitySim; If not, see http://www.gnu.org/licenses/.

@license GPL-3.0+ http://spdx.org/licenses/GPL-3.0+

Useful links

CitySim webpage

Contributors(a-z):

Aymeric Delmas

Giuseppe Peronato

Acknowledgments

These components have been developed in the framework of the ACTIVE INTERFACES research project, which is part of the National Research Programme "Energy Turnaround" (NRP 70) of the Swiss National Science Foundation (SNSF). Further information on the National Research Programme can be found at www.nrp70.ch.

ghcitysim's Issues

"CitySim-LoadResults": problem in (re)order of surfaces

issues report (about groundtemp)

HI,
Sorry to bother.
I am a BIG FAN of citysim. Recently, I start to using GHCitySim, ladybug 0.0.62 and honeybee 0.0.59.
A strange warning " 1. Solution exception:name 'groundtemp' is not defined " keep jumping out after I open the example file in the GH citysim resource folder.
Any advice is appreciated.
Mingjie

Invalid climate file produced by EPW-to-Cli

Hi @gperonato !
I've been working with your GHCitySim components (thx for the great work!). I encountered a problem when trying to run the LoadResults component : the component can't find the SW.out file, because there is no such file in my directory.
So maybe the problem comes from the RunSimulation component? Note that the RunSimulation component is able to write the XML files (I find them in my directory and can open them in CitySim).

Thank you!

CitySim-LoadResults

Weird things happening with the LoadResults component. The component cannot find the "test_SW.out" file even though it has been created in the right folder (see screenshot added).

However, disconnecting and reconnecting the "name" panel to the LoadResults component make it work and load the results.

Some problems about the software

hi@gperonato

Thank you very much for these amazing components,this has changed the game for sure.But the honeybee0.0.59 is no longer available on food4rhino.Can this problem be solved？Hoping hear from you.

regards
Yuanyimei

test-solar_SW hasn't been created

Hi there,
I am new at CitySim. I face a problem while loading solar results of the test-solar file. I get the error that the 'solar-test_SW.out' file cannot be found. I checked the 'simulation' directory and the file 'test-solar_SW.out' hasn't been created after executing the citysim solar component. I understand that this is probably a problem of the citysim solver. Could you please help me out with that?
Cheers,
Maria

Some problems in the plug-in installation

Hi@Aymeric Delmas
Thank you very much for these amazing components,this has changed the game for sure.But the honeybee0.0.59 is no longer available on food4rhino.Can you send me a copy of the honeybee0.0.59?My e-mail address [email protected] .Thank you again. Hoping to hear from you.