icepyx icon indicating copy to clipboard operation
icepyx copied to clipboard

improve QUEST documentation

Open JessicaS11 opened this issue 1 year ago • 2 comments

Looking through our docs page, it would be great to add some more QUEST documentation/clarity. Specific tasks/ideas:

  • [x] Add uml generation for QUEST (via #498)
  • [x] Clarify the QUEST-icepyx relationship in the API docs (perhaps giving QUEST its own API page?)
  • [ ] Mention QUEST in the intro to icepyx docs (via #514)
  • [ ] provide a detailed guide for adding a dataset via QUEST
  • [ ] Add a tile for QUEST on the home page! (via #497)
  • [x] Add a link to AGU presentation/JupyterBook (and mint DOI for presentation)

JessicaS11 avatar Nov 27 '23 20:11 JessicaS11

Going to start by working on the last checkbox - I think we discussed giving the Jupyterbook a Zenodo link.

Does icepyx have a Zenodo community ID? I could upload the notebook through my personal account, though it might be preferable to have a group Zenodo.

zachghiaccio avatar Jan 08 '24 15:01 zachghiaccio

Resource for building a class, cell by cell, in a JupyterNotebook, for the detailed how-to-add-a-dataset example.

JessicaS11 avatar Mar 15 '24 20:03 JessicaS11