Chris-Nicholas-collaborators / EEP153_team_Malthus

group github repo for Project0
3 stars 0 forks source link

Code Review from Gary Becker group #26

Open elissaxm opened 8 months ago

elissaxm commented 8 months ago

Hello! I am commenting on behalf of my group, Gary Becker. For this repository, I noticed that there is an error when running the "trace_population_growth" in your file called project 1 checkpoints. The error returns: (NameError: name 'trace_population_growth' is not defined).

Additionally, init.py is empty as of now-- there is no code or raw data to download, so I am unsure if you were planning to build off on the file or not. Lastly, the sample_world.qgz under the folder titled "misc" is not able to be downloaded.

Other than that, the code looks good! I especially enjoyed the extra visual tools your group used, such as the nam_pd_2020_1km file!

chrisgnicholas commented 8 months ago

regarding the empty __init__.py file, that is "required to make Python treat directories containing the file as packages", so the main notebook can import it with the statement:

from team_malthus import pop

See: https://docs.python.org/3/tutorial/modules.html#packages

Regarding checkpoints, they should be removed from the repo; this will be added to the "cleanup" issue.

Regarding the .qmz file, this is a QGIS project file, as per: www.qgis.org, that I just wanted to add to the archive. The "proper" way to visualize imagery in a Notebook should be using the gdal package, but after many hours, getting this and dependencies to install on MAC has been elusive.

ligon commented 8 months ago

To avoid misunderstandings such as this it might be useful to add a concise README.md file to the repo, with concise directions about use.