Build collection of jupyter notebooks to illustrate each collector

ioos / pyoos

A Python library for collecting Met/Ocean observations

GNU Lesser General Public License v3.0

34 stars 33 forks source link

Build collection of jupyter notebooks to illustrate each collector #54

Open emiliom opened 8 years ago

emiliom commented 8 years ago

Over the last two years @ocefpaf, myself, and several others (via the ioos system integration test) have created a bunch of jupyter notebooks that use various pyoos collectors. It would help in documenting pyoos usage if we compiled (after some cleanup) these in a notebooks group here.

Off the top of my head, I can remember seeing existing notebooks (including my own) for these collectors:

IoosSweSos
NDBC
COOPS
NERRS
HADS

That'd be a darn good start that hopefully will be fairly easy for a group of us to put together.

emiliom commented 8 years ago

For reference, and to get the ball rolling a bit:

IoosSweSos: https://www.wakari.io/sharing/bundle/emayorga/pyoos_ioos_sos_demo1 (an old notebook)
NDBC:
- https://github.com/emiliom/stuff/blob/master/pyoos_ndbc_demo.ipynb
- https://github.com/ocefpaf/sscsw/blob/master/IOOS_data_demo.ipynb
COOPS: @ocefpaf has a notebook or two
NERRS: https://gist.github.com/emiliom/57e84aee123ca60c4fa3 (an old notebook, before my recent commits)
HADS: https://gist.github.com/emiliom/35db17392c5d652faeb2 (an old notebook, before my 2014 commits)

ocefpaf commented 8 years ago

COOPS: @ocefpaf has a notebook or two

I have this one: http://nbviewer.ipython.org/github/ocefpaf/inundation_notebook/blob/master/inundation_notebook.ipynb

We need to clean them up and make them consistent with each other. Region, filtering, text, etc. I am starting a branch with them.

ocefpaf commented 8 years ago

@emiliom see #55

emiliom commented 8 years ago

@ocefpaf, that was fast!! Maybe too fast ... for me at least. I see you added HADS and NERRS notebooks. I suggest you let me handle that, and I'll make sure the notebooks we use are up-to-date; as I noted, the ones I linked to were fairly old, and I listed them only to add tangible references/examples.

I'm in no hurry on this. I created this issue b/c the idea popped in my head then, and we've been talking about pyoos documentation. I can probably dedicate time to it next week, but not this week.

If your NDBC and COOPS notebooks are already consistent with each other, I'll use those as templates for my notebooks.

ocefpaf commented 8 years ago

@ocefpaf, that was fast!! Maybe too fast ... for me at least. I see you added HADS and NERRS notebooks. I suggest you let me handle that, and I'll make sure the notebooks we use are up-to-date; as I noted, the ones I linked to were fairly old, and I listed them only to add tangible references/examples.

Sure. I just wanted to aggregate them into one place.

If your NDBC and COOPS notebooks are already consistent with each other, I'll use those as templates for my notebooks.

COOPS is ready to be reviewed. NDBC will be ready soon.

emiliom commented 8 years ago

COOPS is ready to be reviewed. NDBC will be ready soon.

Cool! I don't think I'll review it until next week, unfortunately. FYI, my "pyoos time" this week will be focused on helping/prodding :wink: to get a pyoos release soon, and tracking issues with the IoosSweSos collector and 52North SOS that came up last week.

ocefpaf commented 8 years ago

get a pyoos release soon.

Let me know if I can help you with that.

rsignell-usgs commented 7 years ago

@emiliom , can this be closed?

emiliom commented 7 years ago

@rsignell-usgs, well, I never got back to providing updated notebooks. But I won't do that in the next 3-4 weeks either. So, go ahead and close the issue for housekeeping if you'd like, and there's interest in updating notebooks if in the future, I can be pinged.