ioos / ioos_qc

:ballot_box_with_check: :ocean: IOOS QARTOD and other Quality Control tests implemented in Python
https://ioos.github.io/ioos_qc/
Apache License 2.0
46 stars 27 forks source link

add simple glider data example #94

Closed callumrollo closed 1 year ago

callumrollo commented 1 year ago

Starting to address #58 with an example of QC for a glider dataset. This notebook can be expanded to include qc of more variables, and the process of creating qc variables for the original glider dataset

review-notebook-app[bot] commented 1 year ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

callumrollo commented 1 year ago

Tests are failing due to flake8 migration to GitHub. These checks should be green once #95 is merged

ocefpaf commented 1 year ago

Tests are failing due to flake8 migration to GitHub. These checks should be green once #95 is merged

Do you want to rebase this to make the tests pass?

callumrollo commented 1 year ago

I'm not sure what to do with the codespell failure. Should the notebook be restarted with cleared output when committed?

ocefpaf commented 1 year ago

I'm not sure what to do with the codespell failure. Should the notebook be restarted with cleared output when committed?

I'm trying to avoid commiting notebooks with outputs for many reasons, that is one of them. However, if we are going to use this in the docs we need to run it before rendering the docs. for now, I would just commit it without any outputs. I can take care of the docs later.

callumrollo commented 1 year ago

I've cleared the notebook output. Hopefully all clear now. Is the notebook itself ok as example? Do you want more detail or explanation?

ocefpaf commented 1 year ago

@callumrollo let's avoid committing the netCDF file to the repo. I'll add it as an asset for you and send the URL in a bit. Hold on...

ocefpaf commented 1 year ago

@callumrollo let's avoid committing the netCDF file to the repo. I'll add it as an asset for you and send the URL in a bit. Hold on...

Here you go: https://github.com/ioos/ioos_qc/releases/download/2.1.0/nrt_SEA067_M37.nc

It is versioned but I used the current release for it. Ideally, in the future, we should add it to future release via a draft release, to obtain the URLs, before making an official release.

PS: You can use pooch to manage the asset download like:

import pooch

url = f"https://github.com/ioos/ioos_qc/releases/download"
version = "2.1.0"
fname = "nrt_SEA067_M37.nc"

download = pooch.retrieve(
    url=f"{url}/{version}/{fname}",
    known_hash="sha256:06e8a79cc17a2d55bb32dbfdc85f9922c1a1cc14726df004ae971125f91b27ac",
)
callumrollo commented 1 year ago

downloading with pooch now

callumrollo commented 1 year ago

@ocefpaf any further changes you'd like to see before we can merge?

ocefpaf commented 1 year ago

@ocefpaf any further changes you'd like to see before we can merge?

Not on my side. @kwilcox is this OK to go?

callumrollo commented 1 year ago

Great! I'm happy for it to be merged, I don't have the rights on this repo