Installation guide for Windows¶
Follow these instructions to install the CEA on a Windows system (tested with Windows 10)
Download and install Git (64-bit).
Download and install Github Desktop (64-bit).
- Download and install Pycharm Community edition (64-bit).
OR your own favorite editor.
Download and install Daysim.
Download and install the ArcGIS Desktop Background Geoprocessing (64 Bit).
ArcGIS (with Background Geoprocessing) is required to run the thermal network layout script. Otherwise, ArcGIS is only used for visualisation purposes.
- Open Github Desktop from the start menu.
- Press Ctrl+Shift+O (clone repository) and select the URL tab.
- Paste the CEA Github address: https://github.com/architecture-building-systems/CityEnergyAnalyst
- Click Clone.
- Open Anaconda prompt (terminal console) from the start menu.
cd Documents\Github\CityEnergyAnalystand press ENTER.
conda env createand press ENTER.
activate ceaand press ENTER.
pip install -e .[dev]and press ENTER (mind the dot ‘.’ included in this comand!).
- Grab a cup of tea and some toast, this will take about 45 minutes.
cea install-toolboxand press ENTER.
Configuration of Pycharm¶
- Open PyCharm from the start menu and open project CityEnergyAnalyst (stored where you downloaded CEA (/Documents).
File>Settings>Project:CityEnergyAnalyst>Project Interpreter>Project Interpreter.
- Click on the settings button (it looks like a wheel) next to the current interpreter path, and click Add.
Conda Environmentfrom the left hand list and select existing environment.
- Point to the location of your conda environment. It should look something like
C:\Users\your_name\AppData\Local\conda\conda\envs\cea\python.exe. Where ‘your_name’ represents your user name in windows.
- Click apply changes.
We advise to follow the above guide precisely. Especially the
conda env create command can trip up users
with previous experience in Anaconda / Miniconda as it looks very similar to the
conda create command often
used to create new conda environments.
In addition to creating an environment,
conda env create reads in the
environment.yml file which contains a
list of packages (and versions) to install as well as a definition of the channels to check. If you
need to create a conda environment for the CEA that has a specific name (the default is
cea) then use the
conda env create --name your-env-name-here