search

pydata / xarray

N-D labeled arrays and datasets in Python
https://xarray.dev
Apache License 2.0
3.55k stars 1.06k forks source link

Jupyter Notebooks for Tutorials(USER GUIDE) #2980

Open hdsingh opened 5 years ago

hdsingh commented 5 years ago

This issue is more of a suggestion.

A small issue that users reading documentation face is unavailability of jupyter notebooks for the tutorial docs User Guide. User constantly has to copy paste code from the documentation or .rst file which results in wastage of time. Having executable notebooks for new users would help them save time and quickly move on to using xarray for their specific tasks.It would ease the learning process for new users which may somehow bring more contributors to xarray community.

Let's take example of pyviz, holoviews, pytorch.

00 Setup — PyViz 0.10.0 documentation

holoviews/examples/user_guide at master · pyviz/holoviews · GitHub

Chatbot Tutorial — PyTorch Tutorials 1.1.0.dev20190507 documentation

All of them provide option to download the tutorial in the form of .ipynb file either in the beginning or end of the notebook.

dcherian commented 5 years ago

Thanks @hdsingh.

@rabernat has a notebook for his class here: https://github.com/rabernat/research_computing/blob/master/content/lectures/python/xarray.ipynb

A list of similar notebooks would be a good addition to the docs. Have you found any others?

hdsingh commented 5 years ago

@dcherian I will go through this notebook and list here other notebooks if I find some. Thanks!

hdsingh commented 5 years ago
  1. pangeo-tutorial-sea-2018/1.1.xarray-data-structures.ipynb at master · pangeo-data/pangeo-tutorial-sea-2018
  2. pangeo-tutorial-sea-2018/1.2.xarray-the-power-of-labels.ipynb at master · pangeo-data/pangeo-tutorial-sea-2018
  3. pangeo-tutorial-sea-2018/1.3.xarray-computation-toolkit.ipynb at master · pangeo-data/pangeo-tutorial-sea-2018
  4. pangeo-tutorial-sea-2018/1.3.xarray-computation-toolkit.ipynb at master · pangeo-data/pangeo-tutorial-sea-2018
  5. pangeo-tutorial-sea-2018/1.4.xarray-visualization.ipynb at master · pangeo-data/pangeo-tutorial-sea-2018
  6. pangeo-tutorial-sea-2018/1.5.xarray-input-and-output.ipynb at master · pangeo-data/pangeo-tutorial-sea-2018

OR

jhamman/xarray_tutorial

AND

pangeo-data/pangeo_ocean_examples: Examples of analysis of ocean data and simulation outputs using xarray, xgcm, and pangeo.