Add readme #1

Merged
a_adli merged 9 commits from feature/add_readme into main 2024-11-20 12:03:34 -05:00
Member

I added a readme.

I added a readme.
a_adli added 1 commit 2024-10-31 12:03:54 -04:00
a_adli requested review from k_wells 2024-10-31 12:04:32 -04:00
k_wells reviewed 2024-10-31 13:08:32 -04:00
@ -0,0 +13,4 @@
## About mtl_gis_oo
This project automates the process of integrating and cleaning updated datasets related to Montreal buildings with an object-oriented approach.
Owner

Remove the word 'updated' and 'object-oriented approach'

Remove the word 'updated' and 'object-oriented approach'
a_adli marked this conversation as resolved
k_wells reviewed 2024-10-31 13:23:51 -04:00
@ -0,0 +14,4 @@
## About mtl_gis_oo
This project automates the process of integrating and cleaning updated datasets related to Montreal buildings with an object-oriented approach.
It is the continuation of non-object-oriented project namely [hydroquebec_archetype_gispy](https://ngci.encs.concordia.ca/gitea/a_adli/hydroquebec_archetype_gispy). The project involves the following datasets:
Owner

I would remove the 'non-object-oriented project' and just say that it is a continuation of the project and provide the link

I would remove the 'non-object-oriented project' and just say that it is a continuation of the project and provide the link
a_adli marked this conversation as resolved
k_wells reviewed 2024-10-31 13:24:50 -04:00
@ -0,0 +21,4 @@
3. [Montreal Property Assesment Units](https://donnees.montreal.ca/dataset/unites-evaluation-fonciere)
4. [Administrative boundaries of the agglomeration of Montréal (boroughs and related cities)](https://donnees.montreal.ca/dataset/limites-administratives-agglomeration)
The workflow has been developed and implemented in ArcGIS. This workflow (link) involves steps such as fixing geometries, clipping unnecessary parts of the map, splitting sections based on single building footprints, spatially joining datasets, and cleaning the data through processes such as removing duplicates, among others.
Owner
  • The original workflow was developed in ArcGIS by Kartikay Sharma (his email)

  • don't forget to add the link to the workflow, maybe contact Kartikay if needed

  • I would re-word 'clipping unnecessary parts of the map' as the clipping is doing something different

- The _original_ workflow was developed in ArcGIS by Kartikay Sharma (his email) - don't forget to add the link to the workflow, maybe contact Kartikay if needed - I would re-word 'clipping unnecessary parts of the map' as the clipping is doing something different
a_adli marked this conversation as resolved
k_wells reviewed 2024-10-31 13:43:36 -04:00
README.md Outdated
@ -0,0 +42,4 @@
This module is not being used or developed right now.
<a name="standalone_vs.py"/>
Owner

This file does not exist in this project so this section should be removed

This file does not exist in this project so this section should be removed
a_adli marked this conversation as resolved
k_wells reviewed 2024-10-31 14:06:53 -04:00
README.md Outdated
@ -0,0 +6,4 @@
[About mtl_gis_oo](#about-gispy)
[scrub_layer_class.py](#scrublayer)
[handle_mtl_ds_workflow.py](#handle_mtl_ds_workflowpy)
[standalone_vs.py](#standalone_vspy)
Owner
  • Remove reference to stsandalone_vs.py as this is coming from the previous project.

  • Rename scrub_mtl_class.py to scrub_mtl.py and call this section ScrubMTL

  • I suggest renaming input_paths_and_layers.py to config.py and adding this section. Call the section Configuration or Config

  • I suggest renaming basic_functions.py to helpers.py and adding this section. Call the section Helpers or Helper Functions

- Remove reference to stsandalone_vs.py as this is coming from the previous project. - Rename scrub_mtl_class.py to scrub_mtl.py and call this section ScrubMTL - I suggest renaming input_paths_and_layers.py to config.py and adding this section. Call the section Configuration or Config - I suggest renaming basic_functions.py to helpers.py and adding this section. Call the section Helpers or Helper Functions
Author
Member

I removed the standalone_vs.py references, but the other 'standalone's are used to refer to PyQGIS as its documentation refers to it as standalone.
(I am editing based on your suggestions, which I am grateful for)

I removed the standalone_vs.py references, but the other 'standalone's are used to refer to PyQGIS as its documentation refers to it as standalone. (I am editing based on your suggestions, which I am grateful for)
k_wells marked this conversation as resolved
k_wells reviewed 2024-10-31 14:10:11 -04:00
README.md Outdated
@ -0,0 +4,4 @@
## Table of Contents
[About mtl_gis_oo](#about-gispy)
[scrub_layer_class.py](#scrublayer)
Owner

Rename scrub_layer_class.py to scrub_layer.py and call this section ScrubLayer following the class name

Rename scrub_layer_class.py to scrub_layer.py and call this section ScrubLayer following the class name
a_adli marked this conversation as resolved
k_wells reviewed 2024-10-31 14:13:01 -04:00
README.md Outdated
@ -0,0 +5,4 @@
[About mtl_gis_oo](#about-gispy)
[scrub_layer_class.py](#scrublayer)
[handle_mtl_ds_workflow.py](#handle_mtl_ds_workflowpy)
Owner

rename from handle_mtl_ds_workflow.py to montreal_buildings_workflow.py, quebec_buildings_workflow.py, or building_cleanup_workflow.py depending on what you feel fits the best. Call the section Montreal Building Workflow corresponding to the name of the file that you choose

rename from handle_mtl_ds_workflow.py to montreal_buildings_workflow.py, quebec_buildings_workflow.py, or building_cleanup_workflow.py depending on what you feel fits the best. Call the section Montreal Building Workflow corresponding to the name of the file that you choose
a_adli marked this conversation as resolved
k_wells reviewed 2024-10-31 14:13:45 -04:00
README.md Outdated
@ -0,0 +52,4 @@
## Setting up an environment to use standalone PyQGIS How to import qgis.core
#pyqgis #qgis #path #pythonpath
Owner

Remove this line

Remove this line
a_adli marked this conversation as resolved
k_wells reviewed 2024-10-31 14:15:19 -04:00
@ -0,0 +62,4 @@
This is being done in order to access the QGIS Python from the command prompt without mixing with the systems original Python installation(s).
a. Go to the QGIS installation directorys Python folder. e.g. C:\Program Files\QGIS 3.34.1\apps\Python39
b. Duplicate the Python executable (python.exe) by copy-pasting it
Owner

Is there a reason you make a copy instead of just renaming the executable? If this is added to the path variable, your command prompt might point to this version of python 3.9 instead of the user/system installation of python 3.9 if it exists. It might be better to use a shortcut in this directory that points to the original python 3.9

Is there a reason you make a copy instead of just renaming the executable? If this is added to the path variable, your command prompt might point to this version of python 3.9 instead of the user/system installation of python 3.9 if it exists. It might be better to use a shortcut in this directory that points to the original python 3.9
a_adli marked this conversation as resolved
k_wells reviewed 2024-10-31 14:16:29 -04:00
@ -0,0 +70,4 @@
a. Go to Environmental Variables (from Windows start)
b. Click on Path and then click on Edit. Add the following paths:
> i. C:\Program Files\QGIS 3.34.1\apps\Python39\pythonqgis
Owner

this is not needed as the following line will allow for all files inside of C:\Program Files\QGIS 3.34.1\apps\Python39 to be accessible in Command Prompt or Powershell

this is not needed as the following line will allow for all files inside of C:\Program Files\QGIS 3.34.1\apps\Python39 to be accessible in Command Prompt or Powershell
a_adli marked this conversation as resolved
k_wells reviewed 2024-10-31 15:06:38 -04:00
@ -0,0 +89,4 @@
d. In the Python environment, import the package by:
> i. Either import qgis.core
> ii. Or from qgis.core import \*
Owner

It's bad practice to import * so I would remove this line. Generally you only want to import what you need and nothing more.

It's bad practice to import * so I would remove this line. Generally you only want to import what you need and nothing more.
a_adli marked this conversation as resolved
k_wells requested changes 2024-10-31 15:07:32 -04:00
Dismissed
k_wells left a comment
Owner

Hi Ali, here is my first round of feedback. Please take a look at these when you can then I will do a final review to make sure there is nothing that I missed.

Hi Ali, here is my first round of feedback. Please take a look at these when you can then I will do a final review to make sure there is nothing that I missed.
a_adli added 1 commit 2024-11-04 10:16:24 -05:00
a_adli added 1 commit 2024-11-04 10:20:42 -05:00
a_adli added 5 commits 2024-11-04 11:13:30 -05:00
a_adli added 1 commit 2024-11-04 11:30:30 -05:00
Owner

Hi Ali, I am accepting this PR with the changes you have made so far. Please go ahead and merge the branch, then delete the branch. Thanks !

Hi Ali, I am accepting this PR with the changes you have made so far. Please go ahead and merge the branch, then delete the branch. Thanks !
k_wells approved these changes 2024-11-19 12:25:53 -05:00
a_adli merged commit ecbcea41bc into main 2024-11-20 12:03:34 -05:00
a_adli deleted branch feature/add_readme 2024-11-20 12:07:35 -05:00
Sign in to join this conversation.
No reviewers
No Label
No Milestone
No project
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: CERC/mtl_gis_oo#1
No description provided.