New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add example notebooks for Elements #1476

Merged
merged 28 commits into from May 31, 2017

Conversation

Projects
None yet
2 participants
@philippjfr
Member

philippjfr commented May 22, 2017

As one of the main tasks for the new documentation we want to split out the example notebooks. I started converting individual examples and in doing so found that many examples in the existing Element tutorials are either outdated or downright wrong so I started updating them. I got through a fair few of them and made bokeh specific additions. It probably would have been easier to start porting the existing materials and then adapting them once they are added and only then add backend specific additions for the different backend specific versions.

Given that I've already started updating them I'd suggest the following plan, that @jlstevens can help me with. I'd suggest you work through the Elements I've already added and add matplotlib versions for each, making improvements to both versions if you think they are necessary and replacing/removing bits that rely on bokeh features in the matplotlib version (e.g. hover tool -> show_values in the HeatMap example). In the meantime I'll work on bokeh and matplotlib versions of the outstanding elements, which are:

  • Contours
  • QuadMesh
  • Paths
  • Histogram
  • HLine/VLine
  • Arrow
  • Text
  • Spline
  • Box
  • Ellipse
  • Bounds
  • Surface (mpl only)
  • Scatter3D (mpl only)
  • Trisurface (mpl only)

@philippjfr philippjfr added the docs label May 22, 2017

@philippjfr philippjfr changed the title from Add example notebook for Elements to Add example notebooks for Elements May 22, 2017

@philippjfr

This comment has been minimized.

Member

philippjfr commented May 22, 2017

One thing I want to add later is to automatically parse all the other examples and then insert a final cell to each example notebooks which links to all the examples in which the element is used.

@jlstevens

This comment has been minimized.

Member

jlstevens commented May 22, 2017

Sounds like a plan!

@jlstevens

This comment has been minimized.

Member

jlstevens commented May 31, 2017

Note that the Scatter histogram wasn't working (should be fixed in #1501) and the yticks option isn't currently working for Spikes.ipynb (both in the bokeh backend).

@jlstevens

This comment has been minimized.

Member

jlstevens commented May 31, 2017

@philippjfr I've now gone through and updated all the notebooks in the original commit as well as Contours and QuadMesh. I also believe you have some additions you want to make to VectorField.

From now on, I'm happy to edit/review the element notebooks as you push them. Alternatively, I can start authoring some myself in which case we need to decide how to split the remaining elements between us.

@jlstevens

This comment has been minimized.

Member

jlstevens commented May 31, 2017

How about you do Paths and Histogram, I'll add all the annotations and we leave the 3D ones till after we've added all the matplotlib versions?

@philippjfr

This comment has been minimized.

Member

philippjfr commented May 31, 2017

How about you do Paths and Histogram, I'll add all the annotations and we leave the 3D ones till after we've added all the matplotlib versions?

Sounds like a plan, I've got Path and Histogram drafts locally already.

@jlstevens

This comment has been minimized.

Member

jlstevens commented May 31, 2017

I've copied all the bokeh notebooks and I am working through them to update them. So far I've updated: Area, Bounds, Box, BoxWhisker, Contours and Curve.

Issues

  • Contours colormaps should work but hasn't been tested yet (Now works).
  • Bars does not work the same way in matplotlib as bokeh:ValueError: Parameter 'group_index' must be an integer. Skipping it for now.
  • size versus s keyword for overlays in matplotlib.
  • pivot option rejected by matplotlib vectorfield.
  • This issue with matplotlib histograms:

image

Notes:

  • Curves needs a width option in bokeh (funny aspects) which matplotlib doesn't need.
@jlstevens

This comment has been minimized.

Member

jlstevens commented May 31, 2017

Contours colormapping and ticks PRs now merged.

@jlstevens

This comment has been minimized.

Member

jlstevens commented May 31, 2017

This PR contains a ton of work we should probably merge sooner rather than later. I can file an issue about the things we discovered while running through all this. @philippjfr What do you think?

@philippjfr

This comment has been minimized.

Member

philippjfr commented May 31, 2017

Sounds good, let's make sure to squash merge this.

@jlstevens jlstevens merged commit be31282 into master May 31, 2017

1 of 4 checks passed

continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
continuous-integration/travis-ci/push The Travis CI build is in progress
Details
coverage/coveralls Coverage pending from Coveralls.io
Details
s3-reference-data-cache Test data is cached.
Details

@philippjfr philippjfr deleted the element_examples branch Jun 17, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment