city_retrofit/WINDOWS_INSTALL.md

# Prepare your environment.

Download the latest version of python and Microsoft c++ redistributable

* [Microsoft C++ redistributable](https://www.microsoft.com/en-ca/download/details.aspx?id=48145)
* [Python environment](https://www.python.org/downloads/)

# Get the code.

1. First thing you will need is an editor for your source code, that's a personal choice, but we would like to recommend PyCharm community edition, an excellent open-source python editor.

[PyCharm Community edition](https://www.jetbrains.com/pycharm/download/download-thanks.html?platform=windows&code=PCC)

2. Run the installer, and follow the installation instructions for PyCharm, you may change a few options, but the default ones should be fine.

3. Open PyCharm and click on **"Get from Version Control"**.

![pycharm wellcome screen](./docs/img/img_0.png)

4. Select Git as the version control and set the URL to [libs repository](https://binarycat.org/git/Guille/libs.git) as shown in the picture.


![pycharm get from version control screen](./docs/img/img_1.png)


You may need to install Git, by clicking at ***Download and install***.

5. Click Clone to download CERC libs source code.


![pycharm project screen](./docs/img/img_2.png)
you will end with a project like this.


# Configure PyCharm.

We use two spaces as a tab instead of standard [pep8](https://www.python.org/dev/peps/pep-0008/) four spaces indentation.
This option could be configured in PyCharm at the settings screen, as shown in the picture.

![pycharm configuration screen](./docs/img/img_5.png)


# Start your project.

1. Click on file new project like in the image.

![pycharm new project screen](./docs/img/img_3.png)

2. Go to project settings and add the libs project to your own, as shown in the picture.

![pycharm new project screen](./docs/img/img_4.png)

3. Add your first file to your project and click in install requirements to automatically download all the dependencies.

4. When all the dependencies are satisfied, we are good to go to start importing our first model.

by adding the following code to our main.py

```
from geometry.geometry_factory import GeometryFactory

city = GeometryFactory('citygml', 'myfile.gml').city

```