Add readme #1
k_wells
Loading…
Reference in New Issue
Block a user
No description provided.
Delete Branch "feature/add_readme"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
I added a readme.
@ -0,0 +13,4 @@## About mtl_gis_ooThis project automates the process of integrating and cleaning updated datasets related to Montreal buildings with an object-oriented approach.Remove the word 'updated' and 'object-oriented approach'
@ -0,0 +14,4 @@## About mtl_gis_ooThis 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:I would remove the 'non-object-oriented project' and just say that it is a continuation of the project and provide the link
@ -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.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
@ -0,0 +42,4 @@This module is not being used or developed right now.<a name="standalone_vs.py"/>This file does not exist in this project so this section should be removed
@ -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)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
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)
@ -0,0 +4,4 @@## Table of Contents[About mtl_gis_oo](#about-gispy)[scrub_layer_class.py](#scrublayer)Rename scrub_layer_class.py to scrub_layer.py and call this section ScrubLayer following the class name
@ -0,0 +5,4 @@[About mtl_gis_oo](#about-gispy)[scrub_layer_class.py](#scrublayer)[handle_mtl_ds_workflow.py](#handle_mtl_ds_workflowpy)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
@ -0,0 +52,4 @@## Setting up an environment to use standalone PyQGIS – How to import qgis.core#pyqgis #qgis #path #pythonpathRemove this line
@ -0,0 +62,4 @@This is being done in order to access the QGIS Python from the command prompt without mixing with the system’s original Python installation(s).a. Go to the QGIS installation directory’s Python folder. e.g. C:\Program Files\QGIS 3.34.1\apps\Python39b. Duplicate the Python executable (python.exe) by copy-pasting itIs 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
@ -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\pythonqgisthis 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
@ -0,0 +89,4 @@d. In the Python environment, import the package by:> i. Either import qgis.core> ii. Or from qgis.core import \*It's bad practice to import * so I would remove this line. Generally you only want to import what you need and nothing more.
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.
Checkout
From your project repository, check out a new branch and test the changes.