MasayukiMotoori / EOSC556B

Project, EOSC556B, Applied Geophysics, UBC, 2024 Winter session
MIT License
0 stars 0 forks source link

General Feedback on Project #2

Open C-Rutherford opened 7 months ago

C-Rutherford commented 7 months ago

README: The title and description give a good idea of what the project is about. I've added a pull request for some minor changes but overall the description is informative. Maybe add a sub heading that says you're using IP survey data just to make it clear immediately. You should include installation instructions in your README file, as well as short descriptions about what each of your notebooks do and maybe the data you're using.

LICENSE: License file looks good!

Environment and Installation: We were running into issues with importing empymod so maybe just double check this is working, not sure if it's on our end or if there's an installation step that's missing.

Notebooks and code: Your notebooks are well labelled. Having a small description of each one in your README file will help people know for sure where to start. It appears to run without errors (assuming empymod is imported correctly). I really like that you have clear headings throughout the code. Having a few more short descriptions/comments might be helpful. Make sure to have titles for all your plots so we can follow along with what we are plotting and the significance of the plot. I've added a pull request to add titles to a couple of your plots, but feel free to add more descriptive titles if you'd like. I also suggest changing the colours on the last plots in the multilayer notebook just so it's easier to differentiate the lines (not sure what colour is best here). Looks like your notebook runs without errors and the data being plotted makes sense. Way to go! I think those are all the suggestions I have, lmk if you have any questions about my feedback. Great job on your project so far!

MasayukiMotoori commented 7 months ago

Thank you! I appreciate your feedback and suggestions which are much helpful!