Merge remote-tracking branch 'origin/documentation_updates'

# Conflicts:
#	MACOS_INSTALL.md

MACOS_INSTALL.md

@@ -1,104 +1,160 @@
-# 
+# MACOS_INSTALL
-# Prepare your environment
 
-Download the latest version of python and Microsoft c++ redistributable
+This is an installation guide for macOS, covering all the steps needed to begin developing code for the Urban Simulation Platform ‘Hub’.
+At the end of this process you will have installed and configured all the necessary applications, set up your own project on CERC’s Gitlab and created your first python file.
 
-* [Microsoft C++ redistributable](https://www.microsoft.com/en-ca/download/details.aspx?id=48145)
+## Prepare your environment
-* [Python environment](https://www.python.org/downloads/)
 
-# Get the code
+To develop any new code for the Urban Simulation Platform you must have the right software applications installed and configured.
+The Platform is written in python and so the applications you need are:
+* Python Interpreter
+* Python Editor
 
-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)
+You also need to register a user account with the CERC’s code repository on Gitlab and have the necessary permissions for creating new code.
 
-2. Run the installer, and follow the installation instructions for PyCharm, you may change a few options, but the default ones should be fine.
+### Get a Python interpreter
+1. Download the latest version of python for macOS: [Python environment](https://www.python.org/downloads/)
+2. Open the downloaded .pkg file and follow the instructions to install.
 
-3. Open PyCharm and click on **"Get from Version Control"**.
+### Get a Python editor
+1. You will need a python editor in order to import the existing Hub source code and to write your own python code. Whilst this is a personal choice we would like to recommend [PyCharm Community Edition](https://www.jetbrains.com/pycharm/download/#section=mac), an excellent open-source python editor.
+2. Open the downloaded .dmg file and then drag the PyCharm CE app into your Applications folder.
 
-![pycharm welcome screen](docs/img_windows_install/img_0.png)
+![pycharm ce](docs/img_macos_install/img_0.png)
 
-You can find it also at VCS -> Get from Version Control...
+## Get the CERC Hub source code
 
-![pycharm get from version control](docs/img_windows_install/img_6.png)
+1. Run PyCharmCE
+2. Click on the **Get from VCS** button in the top right of the window.
+
+![get_vc_1](docs/img_macos_install/img_1.png)
+
+3. Select **Git** as the **Version control**. For the URL use the link to the Hub repository, as seen below.
+
+![get_vc_2](docs/img_macos_install/img_2.png)
+
+(You can also copy this URL by going to the Hub repository in [Gitlab](https://rs-loy-gitlab.concordia.ca/Guille/hub) 
+and clicking on the Copy URL button next to **Clone with HTTPS**)
+ 
+![git_lab](docs/img_macos_install/img_3.png)
+
+The Directory to store the Hub source code locally is automatically created for you. Edit this if you prefer it to be stored somewhere else.
+
+Note: If you see a message saying Git is not installed, click on the **Download and install** and follow instructions.
+
+4.	Click the ‘Clone’ button to download CERC Hub source code.
+
+(If the macOS security asks if you trust executing this source code, you can click **Trust Project**.)
+
+![trust_project](docs/img_macos_install/img_4.png)
+ 
+You will then see the project directories and files below, with the hub readme document displayed. 
+You have successfully cloned a copy of the CERC hub onto your computer.
+
+![hub_readme](docs/img_macos_install/img_5.png)
 
 
-4. Select Git as the version control, and set the URL to [Hub repository](https://rs-loy-gitlab.concordia.ca/Guille/hub.git) as shown in the picture.
+## Create Your Own Branch of the Hub
-At the website, copy the URL from Clone -> Clone with HTTPS.
 
-![pycharm get from version control screen](docs/img_windows_install/img_1.png)
+You now need to create a new **Branch** of the Hub source code. This is like your own special version of the Hub, where you can safely integrate your model, without affecting the smooth running of the Main Branch Hub and the Platform.
 
+1. Create your working branch by right-clicking on the project folder (hub) and then selecting **Git->New Branch...**
 
-You may need to install Git, by clicking at ***Download and install***. 
+![new_branch](docs/img_macos_install/img_6.png)
-If that message does not appear is because you have it already installed in your computer.
 
-5. Click Clone to download CERC hub source code. You will end with a project like this:
+2. Give a name to your branch that has some sense of what will be done with it, _updating_documentation_, 
+_lca_classes_,... And, click on the **Create** button.
 
+![name_branch](docs/img_macos_install/img_7.png)
 
-![pycharm project screen](docs/img_windows_install/img_2.png)
+3. Click on the **Git** button in the bottom-left corner to pop-up the window showing the Git information. 
+See your new branch has been created under _Local_.
 
-6. To create your working branch you need rights to edit that project. Please, talk to Guillermo (guillermo.gutierrezmorote@concordia.ca) 
+![branch_in_local](docs/img_macos_install/img_8.png)
-or Koa (kekoa.wells@concordia.ca) to get those rights. Once you have them, right-click on the project folder (hub) -> Git -> Repository -> Branches:
 
-![create new branch 1](docs/img_windows_install/img_9.png)
+4. Now we need to let the CERC Gitlab repository know about this new branch. You do this by right-clicking on 
+your branch and selecting **Push...** from the drop-down menu.
 
-And then + New Branch:
+![push_branch_1](docs/img_macos_install/img_9.png)
 
-![create new branch 2](docs/img_windows_install/img_10.png)
+5.	Then click on the **Push** button at the bottom-right of the **Push Commits** window.
 
-Give a name to your branch and open the tab Git at the down-left corner. Right-click on your branch and push.
+![push_branch_2](docs/img_macos_install/img_10.png)
 
-![push new branch 1](docs/img_windows_install/img_11.png)
+Note - at this point you may need to login to Gitlab using you Concordia credentials.
 
-![push new branch 2](docs/img_windows_install/img_12.png)
+![gitlab_credentials](docs/img_macos_install/img_11.png)
 
-Check that your branch appears in the Remote list:
+Check that your branch now appears in the _Remote_ branch hierarchy, in the bottom-left corner. If it does not appear, 
+contact Guille (guillermo.gutierrezmorote@concordia.ca) or Koa (), to find the reason of the error.
 
-![check all set](docs/img_windows_install/img_13.png)
+![branch_pushed](docs/img_macos_install/img_12.png)
 
-If your branch is there, you are done with this part.
+## Configure Pycharm
 
-# Configure PyCharm
+When integrating your model with the Platform, it is important that you follow [CERC’s coding style guidelines](PYGUIDE.md). 
+One of the rules is that we use two spaces as a tab instead of the standard pep8 four spaces indentation. 
+This option can be configured in PyCharm at the settings screen.
 
-We use two spaces as a tab instead of standard [pep8](https://www.python.org/dev/peps/pep-0008/) four spaces indentation.
+To access the settings screen, click on the gear icon in the top right corner, and select **Preferences** from 
-This option can be configured in PyCharm at the settings screen, as shown in the picture.
+the drop-down menu. The Preferences window will appear. From the panel on the left, select 
+**Editor->Code Style->Python** and you will see where tab size can be changed. Change it to 2. 
+See the picture below.
  
-![pycharm configuration screen](docs/img_windows_install/img_5.png)
+![configure_pycharm](docs/img_macos_install/img_13.png)
 
+## Set up a new project on Gitlab 
 
-# Start your project
+1. Open a browser and to the [CERC Git](https://rs-loy-gitlab.concordia.ca/). Click on the blue **New project** button.
 
-1. At our Git (https://rs-loy-gitlab.concordia.ca/), click on New project:
+![git_new_project](docs/img_macos_install/img_14.png)
 
-![git new project screen](docs/img_windows_install/img_14.png)
+2.	Choose the **Create blank project** option from the three options seen below.
 
-The create a black project with the desired name (remember to follow our ![Coding Style](PYGUIDE.md)). 
+![blank_project](docs/img_macos_install/img_15.png)
-Be sure that Initialize repository with a README is selected, and ideally, that the Visibility Level is Public. 
  
-![git give a name](docs/img_windows_install/img_15.png)
+3. Type in a name (remember to follow the CERC naming conventions). Check the option **Initialize repository with a README**, 
+and ideally, check the **Visibility Level** to be **Public**. Then click on the **Create project** button.
 
-And finally, clone it following the same steps as for ![hub](WINDOWS_INSTALL.md#get-the-code) (steps 3 to 5).
+![project_created](docs/img_macos_install/img_16.png)
 
-2. Go to project settings and add the hub project to your own, by clicking on Add Content Root:
+You should then see a confirmation screen with all the information about your new project.
 
-![pycharm new project screen](docs/img_windows_install/img_4.png)
+![confirmation_project](docs/img_macos_install/img_17.png)
 
-![pycharm add hub](docs/img_windows_install/img_7.png)
+## Get your project into Pycharm
 
-3. Add your first file to your project and click on install requirements to automatically download all the dependencies (in blue at top-right corner).
+1. Now you can make a clone of this project, within PyCharm. First, copy the URL by clicking on the blue **Clone** button 
+and then click on the **Copy URL** button next to the **Clone with HTTPS** link.
 
-![pycharm add dependencies](docs/img_windows_install/img_8.png)
+![copy_https](docs/img_macos_install/img_18.png)
 
-4. When all the dependencies are satisfied, you are all set to start importing your first city model.
+2. Switch back to PyCharm and close the Hub project by choosing **File->Close Project**. You will then see the 
+**Welcome To PyCharm** window again.
 
+3. Clone a copy of your Project into PyCharm, following the steps 2-6 of the _GET THE CERC HUB SOURCE CODE_ 
+section above, but using the URL link that you just copied for your gitlab project.
+
+4. Select **Pycharm->Preferences** to open the **Preferences** window. From the panel on the left click on 
+**Project:<project name> -> Project Structure**.
+ 
+![new_project_in_pychaem](docs/img_macos_install/img_19.png)
+
+5.	Add the Hub project to your own, by clicking on Add Content Root: (Pilar, this is where it all went wrong for me :-) )
+
+## Create your first Python file
+
+Add your first file to your project and click on install requirements to automatically download all the dependencies 
+(in blue at top-right corner).
+
+When all the dependencies are satisfied, you are all set to start importing your first city model.
 Add the following code to your main.py
-
-```python
-
 from imports.geometry_factory import GeometryFactory
 
 city = GeometryFactory('citygml', 'myfile.gml').city
-```
 
-5. Always remember to push your own project changes as the last thing you do before ending your working day! 
+Always remember to push your own project changes as the last thing you do before ending your working day! 
-First, commit your changes by clicking on the green check at the top-right corner of Pycharm. Add a comment that explains briefly your changes. 
+First, commit your changes by clicking on the green check in the top-right corner of Pycharm. Add a comment 
-Then, pull by clicking on the blue arrow to be sure that there are no conflicts between your version (local) and the remote one (gitlab). 
+that explains briefly your changes. Then, pull by clicking on the blue arrow to be sure that there are no 
-Once the conflicts are solved and the merge in local is done, push the changes by clicking on the green arrow.
+conflicts between your version (local) and the remote one (gitlab). Once the conflicts are solved and the merge in 
+local is done, push the changes by clicking on the green arrow.