summer_course_2024/WINDOWS_INSTALL.md

# Prepare your environment.

Download the latest version of python and Mycrosoft 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 recomend PyCharm community edition, a wonderful 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 instalation 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 2 spaces as a tab instead standard [pep8](https://www.python.org/dev/peps/pep-0008/) 4 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 own 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 satistied, 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

```