Add function to load PREM

fatiando / rockhound

NOTICE: This library is no longer being developed. Use Ensaio instead (https://www.fatiando.org/ensaio). -- Download geophysical models/datasets and load them in Python

BSD 3-Clause "New" or "Revised" License

34 stars 15 forks source link

Add function to load PREM #10

Closed santisoler closed 6 years ago

santisoler commented 6 years ago

Add function to load PREM data into pandas.DataFrame. Add tests for the new function, entry in the documentation and a gallery example. Add pandas as dependency.

Fixes #8

Reminders

[x] Run make format and make check to make sure the code follows the style guide.
[x] Add tests for new features or tests that would have caught the bug that you're fixing.
[x] Add new public functions/methods/classes to doc/api/index.rst.
[x] Write detailed docstrings for all functions/methods.
[x] If adding new functionality, add an example to the docstring, gallery, and/or tutorials.

welcome[bot] commented 6 years ago

💖 Thanks for opening this pull request! 💖

Please make sure you read our Contributing Guide and abide by our Code of Conduct.

A few things to keep in mind:

Remember to run make format to make sure your code follows our style guide.
If you need help writing tests, take a look at the existing ones for inspiration. If you don't know where to start, let us know and we'll walk you through it.
All new features should be documented. It helps to write the docstrings for your functions/classes before writing the code. This will help you think about your code design and results in better code.
No matter what, we are really grateful that you put in the effort to do this! ⭐

santisoler commented 6 years ago

@leouieda I have a few questions:

Should we add pandas as dependency?
Once the documentation is build, the pandas.DataFrame has no link, how can we solve it?
pylint raises an error with the :math:\eta string in the docstring of fetch_prem() function. I don't know why this would be an error.

santisoler commented 6 years ago

@leouieda I've added pandas as dependency, fixed the r""" issue and added columns names a their units in prem DataFrame.

I've also fixed some issues regarding styling. If you agree, this PR is ready to merge.

welcome[bot] commented 6 years ago

🎉🎉🎉 Congrats on merging your first pull request and welcome to the team! 🎉🎉🎉

Please open a new pull request to add yourself to the AUTHORS.md file. We hope that this was a good experience for you. Let us know if there is any way that the contributing process could be improved.

leouieda commented 6 years ago

:+1: thanks, Santi!