Package: rockhound
rock hound :nounA specialist in geology¹An amateur rock and mineral collector¹A Python library to download and read common geophysical models and datasets²¹Merriam Webster dictionary|
² Not a real dictionary definition.Documentation|Documentation (dev version)|Contact|
Part of theFatiando a TerraprojectDisclaimer🚨This package is in early stages of design and implementation.🚨We welcome any feedback and ideas!
Let us know by submittingissues on Githubor send us a message on ourGitter chatroom.AboutRockHound is a Python library to download geophysical models and datasets (PREM,
CRUST1.0, ETOPO1) and load them into Python data structures (pandas, numpy, xarray).Many of these models use non-conventional file formats or can be tricky
to find on the internet. RockHound knows how to download them if you don’t already have
them locally, read the file format, and return a nicely formatted data structure.
Under the hood, it usesPoochto
manage the downloads.Project goalsDownload commonly used models and datasets.Load data intopandas.DataFrame(tables) andxarray.Dataset(grids).Only download if needed and check downloads for corruption.Provide functions for visualizing complex models and datasets.Contacting UsMost discussion happenson Github.
Feel free toopen an issueor comment
on any open issue or pull request.We havechat room on Gitterwhere you can ask questions and leave comments.Citing RockHoundThis is research softwaremade by scientists(seeAUTHORS.md). Citations help us
justify the effort that goes into building and maintaining this project. If you used
RockHound for your research, please consider citing us.See ourCITATION.rst fileto find out more.ContributingCode of conductPlease note that this project is released with aContributor Code of Conduct.
By participating in this project you agree to abide by its terms.Contributing GuidelinesPlease read ourContributing Guideto see how you can help and give feedback.Imposter syndrome disclaimerWe want your help.No, really.There may be a little voice inside your head that is telling you that you’re
not ready to be an open source contributor; that your skills aren’t nearly good
enough to contribute.
What could you possibly offer?We assure you that the little voice in your head is wrong.Being a contributor doesn’t just mean writing code.
Equality important contributions include:
writing or proof-reading documentation, suggesting or implementing tests, or
even giving feedback about the project (including giving feedback about the
contribution process).
If you’re coming to the project with fresh eyes, you might see the errors and
assumptions that seasoned contributors have glossed over.
If you can write any code at all, you can contribute code to open source.
We are constantly trying out new skills, making mistakes, and learning from
those mistakes.
That’s how we all improve and we are happy to help others learn.This disclaimer was adapted from theMetPy project.LicenseThis is free software: you can redistribute it and/or modify it under the terms
of theBSD 3-clause License. A copy of this license is provided inLICENSE.txt.Documentation for other versionsDevelopment(reflects themasterbranch on
Github)Latest releasev0.2.0v0.1.0