You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The documentation is very thorough, but I think one thing that would help new users is an "intro to working with pydov" tutorial. This tutorial would explains things at a level between the quickstart and the very detailed tutorials for each individual search object. What this tutorial would provide, that the current tutorials do not have, is an introduction to the core abstractions provided by the package. I notice that each DOV search tutorial follows the same structure, but there is not a lot of language about why a potential user might want to use some of the functionality, e.g. why get all the groundwater screens / boring holes within a bounding box.
The intro tutorial would ideally be a specific example of an analysis--it could even be one of the existing search tutorials--that introduces the concepts that repeat throughout the individual tutorials for each search object. This intro should be targeted at a "naive" researcher who is interested in having access to the data, but might not be familiar with some of the existing data structures and libraries that pydov leverages, e.g. the WFS protocol. I admit to a total lack of domain expertise in this area, so the devs' idea of what a "naive" researcher would know compared to mine might vary, but I think that adding an intro with more language about about what and why the package does what it does, in addition to how to do those things, would make it more welcoming to new users.
The documentation looks very detailed and instructive about how to use the library. I agree with David, maybe would be good to have a tutorial with an introduction something like a blog post (also it could be posted on PyOpenSci blog section).
The text was updated successfully, but these errors were encountered:
@pjhaest Did you make any progress on this yet? This was one of the main points in the pyOpenSci review so I think we need to tackle this before proceeding with the review process. Be sure to push your WIP so we can collaborate here :)
yes, sorry, last-minute project proposal came in between, along with some other things, as always.
I will start on it right away, if you haven't already? I was planning to add the tutorial as a seperate page to the docs, or would you prefer a seperate notebook?
Now that I look at it, actually that would be elaborating the 'Quick start' page, ok?
short update, I just started a new Notebook. Will upload tomorrow. Easier to comment/change than an rst. And probably even better to leave it at that and refer to the notebook in the docs.
From the pyOpenSci review:
The text was updated successfully, but these errors were encountered: