issue_comments

Table actions

11 rows where issue = 353150483 sorted by updated_at descending

✎ View and edit SQL

This data as json, CSV (advanced)

Suggested facets: reactions, created_at (date), updated_at (date)

author_association 2

issue 1

  • Adding tutorials to xarray documentation splash page · 11 ✖
id html_url issue_url node_id user created_at updated_at ▲ author_association body reactions performed_via_github_app issue
511127625 https://github.com/pydata/xarray/issues/2378#issuecomment-511127625 https://api.github.com/repos/pydata/xarray/issues/2378 MDEyOklzc3VlQ29tbWVudDUxMTEyNzYyNQ== rabernat 1197350 2019-07-13T14:47:37Z 2019-07-13T14:47:37Z MEMBER

FYI in the scipy19-docs branch we are now using nbsphinx. I couldn't get sphinx-nbexamples to work.

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Adding tutorials to xarray documentation splash page 353150483
510721164 https://github.com/pydata/xarray/issues/2378#issuecomment-510721164 https://api.github.com/repos/pydata/xarray/issues/2378 MDEyOklzc3VlQ29tbWVudDUxMDcyMTE2NA== dcherian 2448579 2019-07-12T02:32:49Z 2019-07-12T02:32:49Z MEMBER

I think that sounds great and compatible with the binder ideas on this thread

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Adding tutorials to xarray documentation splash page 353150483
510683661 https://github.com/pydata/xarray/issues/2378#issuecomment-510683661 https://api.github.com/repos/pydata/xarray/issues/2378 MDEyOklzc3VlQ29tbWVudDUxMDY4MzY2MQ== rabernat 1197350 2019-07-11T22:58:28Z 2019-07-11T22:58:28Z MEMBER

@dcherian - in Pangeo we are using sphinx-nbexamples instead of sphinx-gallery. I like it more becuase you provide the examples as notebooks, rather than scripts, which is better suited to longer, more detailed examples.

How would you feel about refactoring the gallery to use sphinx-nbexamples, and then using this for the tutorials as well?

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Adding tutorials to xarray documentation splash page 353150483
510678695 https://github.com/pydata/xarray/issues/2378#issuecomment-510678695 https://api.github.com/repos/pydata/xarray/issues/2378 MDEyOklzc3VlQ29tbWVudDUxMDY3ODY5NQ== dcherian 2448579 2019-07-11T22:35:14Z 2019-07-11T22:35:14Z MEMBER

I think we should combine the example notebooks with "gallery"

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Adding tutorials to xarray documentation splash page 353150483
510675515 https://github.com/pydata/xarray/issues/2378#issuecomment-510675515 https://api.github.com/repos/pydata/xarray/issues/2378 MDEyOklzc3VlQ29tbWVudDUxMDY3NTUxNQ== rabernat 1197350 2019-07-11T22:22:08Z 2019-07-11T22:22:08Z MEMBER

I plan on getting this started during the Xarray SciPy sprint on Saturday.

I would like to see a high-level tutorials heading in our documentation, like this

(I'm not proposing to eliminate the User Guide, I just suck at annotating screenshots.)

I think the "example" page should be refactored into more verbose tutorials. The examples are a bit stale.

Ideas? Feedback? 

{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Adding tutorials to xarray documentation splash page 353150483
416772369 https://github.com/pydata/xarray/issues/2378#issuecomment-416772369 https://api.github.com/repos/pydata/xarray/issues/2378 MDEyOklzc3VlQ29tbWVudDQxNjc3MjM2OQ== JiaweiZhuang 25473287 2018-08-28T23:24:46Z 2018-08-28T23:24:46Z NONE

Just FYI, I wrote a xarray tutorial at https://github.com/geoschem/GEOSChem-python-tutorial with Binder enabled.

I taught it in several GEOS-Chem user workshops and it turned out to work pretty well. Most of our users only know MATLAB&IDL, so I have to teach Python from scratch and then introduce xarray. I found IDL vs xarray a good example to "wow" new users. Manipulating NetCDF files is a real pain in those old languages. There is also a chapter on xESMF, of course😉

I use GEOS-Chem data as an example, but most contents are quite general and should be useful for other geoscience users.

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Adding tutorials to xarray documentation splash page 353150483
416756590 https://github.com/pydata/xarray/issues/2378#issuecomment-416756590 https://api.github.com/repos/pydata/xarray/issues/2378 MDEyOklzc3VlQ29tbWVudDQxNjc1NjU5MA== jhamman 2443309 2018-08-28T22:06:38Z 2018-08-28T22:06:38Z MEMBER

see https://github.com/xarray-contrib/binder-tutorial for a start here. I opened specific issues for the three notebooks @shoyer identified. 

{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Adding tutorials to xarray documentation splash page 353150483
416749358 https://github.com/pydata/xarray/issues/2378#issuecomment-416749358 https://api.github.com/repos/pydata/xarray/issues/2378 MDEyOklzc3VlQ29tbWVudDQxNjc0OTM1OA== jhamman 2443309 2018-08-28T21:37:44Z 2018-08-28T21:37:44Z MEMBER

Calling volunteers to help develop some of these tutorials? I'll volunteer to setup a binder ready repository and review any notebooks that get put together. 

{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Adding tutorials to xarray documentation splash page 353150483
415231442 https://github.com/pydata/xarray/issues/2378#issuecomment-415231442 https://api.github.com/repos/pydata/xarray/issues/2378 MDEyOklzc3VlQ29tbWVudDQxNTIzMTQ0Mg== orianac 5796208 2018-08-23T00:27:04Z 2018-08-23T00:27:04Z NONE

Also, showcasing the nifty plotting functionality could be nice. As someone who spends so much time making plots, proof that it's easy to just do .plot() could be very persuasive for trying out xarray!

 
{
    "total_count": 1,
    "+1": 1,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Adding tutorials to xarray documentation splash page 353150483
415230263 https://github.com/pydata/xarray/issues/2378#issuecomment-415230263 https://api.github.com/repos/pydata/xarray/issues/2378 MDEyOklzc3VlQ29tbWVudDQxNTIzMDI2Mw== shoyer 1217238 2018-08-23T00:20:44Z 2018-08-23T00:20:44Z MEMBER

I agree that advertising tutorials prominently would be a real win. The current xarray documentation leans towards being an authoritative reference, which is less helpful for new users.

Throwing out some ideas for :

  • Xarray for geoscience users
    • load/save netCDF data
    • calculate climatologies
    • regridding/interpolation? maybe using xESMF?
  • Xarray for general data analysis
  • show how xarray does alignment like pandas
  • show how xarray does broadcasting (sort of like numpy)
  • show how xarray works easily with numpy and pandas
  • Xarray for parallel computing
  • show how everything scales up with dask?
 
{
    "total_count": 2,
    "+1": 2,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Adding tutorials to xarray documentation splash page 353150483
415223099 https://github.com/pydata/xarray/issues/2378#issuecomment-415223099 https://api.github.com/repos/pydata/xarray/issues/2378 MDEyOklzc3VlQ29tbWVudDQxNTIyMzA5OQ== jhamman 2443309 2018-08-22T23:42:01Z 2018-08-22T23:42:01Z MEMBER

Thanks @orianac for posting this as an issue. I agree something like this would be really nice to showcase. I'm curious how others think this should be organized. My tutorials () are pretty basic and may not be the most impressive way to "wow" new users. I'm thinking we may be able identify 2 or 3 main use cases / patterns and build out some examples from there. Thoughts?

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   Adding tutorials to xarray documentation splash page 353150483

Advanced export

JSON shape: default, array, newline-delimited, object

CSV options: 

CREATE TABLE [issue_comments] (
   [html_url] TEXT,
   [issue_url] TEXT,
   [id] INTEGER PRIMARY KEY,
   [node_id] TEXT,
   [user] INTEGER REFERENCES [users]([id]),
   [created_at] TEXT,
   [updated_at] TEXT,
   [author_association] TEXT,
   [body] TEXT,
   [reactions] TEXT,
   [performed_via_github_app] TEXT,
   [issue] INTEGER REFERENCES [issues]([id])
);
CREATE INDEX [idx_issue_comments_issue]
    ON [issue_comments] ([issue]);
CREATE INDEX [idx_issue_comments_user]
    ON [issue_comments] ([user]);