add an ipython notebooks to this project (somehow)

[jeremymanning]

I'd like us to link our ipython notebook examples with this project somehow. Some ideas:

• Add a folder with the ipython notebooks
• Host the notebooks somewhere else and add a link to that somewhere else in the readme
• Add links to the ipython notebooks in our hypertools

Another issue we'll need to solve as part of this is to make sure that any links embedded in the notebooks are relative and/or universal (rather than being hard-coded local links that will only work on one computer).

Ideally we would have some or all of the notebooks ready as part of our main release on Friday-- I think they'd help people understand how to use different features and showcase some additional plot styles and ideas. However, we could also add these examples in after the main release as they are ready for sharing.

@lucywowen and I also discussed some new notebook ideas this morning, and in various other meetings we've had more ideas too. It might be helpful to maintain a repository of ipython notebooks of different "data explorations and visualizations," e.g. as part of this repository, our sampleData repository, or a new repository. We could then branch off those demos into full-fledged projects (e.g. @andrewheusser's Indiana Jones analyses), etc.

Thoughts on the best way to do this?

[andrewheusser]

One idea would be to create a separate repo (maybe hypertools-paper) that will house the paper latex file, example data and example notebooks for this project. We could just rename sampleData->hypertools-paper or something else more descriptive. Then, people could use binder (https://github.com/binder-project/binder) to spin up a jupyter notebook (and we could link the binders to the README in the code).

I think we'll want to keep this repo light, specifically for code and simple examples.

[jeremymanning]

sure-- i like the binder idea and keeping the paper in a separate repo that we also share (with the notebooks for producing the figures). how hard are binders to set up? e.g. could you do it while i'm taking a pass through the paper tomorrow?

[andrewheusser]

yep, they are (in theory) super easy to set up. I'll see if I can get the structure set up tomorrow, and then we can add/modify the notebooks

[jeremymanning]

:+1: i don't want this to hold up the paper, but if it's feasible to get it done before our release then i think it'd be nice

[ljchang]

My binder is super cool and easy to use. I don't think you need to even roll your own as the developer (jeremy freeman) is currently paying to host it himself. I would recommend splitting it as a separate repository though like @andrewheusser suggested.

[andrewheusser]

I made a repo for this (hypertools-paper-notebooks). we need to make it public before i can create a binder for it

[jeremymanning]

we can make the hypertools-paper-notebooks repo public early friday afternoon-- nothing will work until we make the hypertools repo public, but it'll allow us to finish getting everything set up before 3pm (i.e. proposed "have everything ready to go" deadline)

[andrewheusser]

👍

[andrewheusser]

i think this is ready to launch. waiting on the tweets notebook, but not critical as we can move forward without it and easily add it when it is ready

[andrewheusser]

leaving this open until we add tweets

[andrewheusser]

closing this and reopening in the notebook repo