Tutorial notebooks needed!!

[Brendan Colloran]

Hi everyone, I got an email from a community member who raised a point that the core team has discussed, but that we haven't discussed yet with the rest of the community:

Our documentation is a bad shape.

We currently have three only example/tutorial notebooks in our "examples" repo:

https://iodide-project.github.io/iodide-examples/what-a-web-notebook-looks-like.html
https://iodide-project.github.io/iodide-examples/eviction-notices-by-sf-neighborhood--1999-2015.html
https://iodide-project.github.io/iodide-examples/output-handling.html

(repo link: https://github.com/iodide-project/iodide-examples)

Of these, only one was set up to demonstrate how a notebook works and/or how to use notebooks, the other two were just intended as demos that show what a notebook can do, but that already assume a good bit of knowledge about how they work.

Overall, what this means is:

***If you are interested in contributing to Iodide, one of the most valuable contributions you can make would be developing tutorial and demo notebooks***

Ideally, this should also be a really *fun* way to contribute, because a demo notebook can be on any topic that interests you -- it could be data analysis, physics simulation, pure math... the possibilities are endless. It can really be anything you like. It would also be a great way to learn js skills; for example, you could replicate d3 examples from https://bl.ocks.org/mbostock, or figure out to reproduce ipython notebooks with JavaScript.

Off the top of my head, there are a few types of demo notebooks that would be most valuable:

- Basic tutorials that show how to use an iodide notebook's built in functionality (keeping in mind that much of our audience will be coming from Jupyter)

- basic tutorials that show how to accomplish basic tasks using a notebook and using JS (keep in mind that much of our audience will be coming from Python, R, or other languages, and might not know JS)

- Demos that show off the advantages of using a browser, so things like real time interactivity, interactive data visualization, 3d stuffs with web gl, and so on

Working on a comprehensive set of docs and demos would also make a great GSOC project proposal for an interested student. It's really that important to the project overall.

Anyway, please feel free to respond to this thread with ideas for tutorial and demo notebooks, and of course with any questions. Also feel free to file issues in the iodide-examples repo.

Thanks! 

Brendan

[Pradeep Gangwar]

I will try adding some examples as soon as i get time and explore more features of iodide.

[Shubham Singh]

I'm working on a demo book to show visualization of sorting algorithms. As soon as it is finish I'll let you know

[Brendan Colloran]

Very nice demo Shubham, thanks!

I merged it and it can be viewed online here:
https://iodide-project.github.io/iodide-examples/visualize-sorting-algorithms.html

I also made a couple suggestions in the PR about some directions you could extend this work if you want to take it further.

Nice job!

-Brendan

On Fri, Mar 2, 2018 at 7:57 PM, Shubham Singh <imshubha...@gmail.com> wrote:

I'm working on a demo book to show visualization of sorting algorithms. As soon as it is finish I'll let you know

--
You received this message because you are subscribed to the Google Groups "iodide-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to iodide-dev+unsubscribe@googlegroups.com.
To post to this group, send email to iodid...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/iodide-dev/caeb48b0-be12-441d-995c-c3f19ff93620%40googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

[Brendan Meade]

Hi.  My name is Brendan Meade and I'm super impressed with Iodide!  It's both beautiful and easy to use.  Based on the Lorenz equations example I've put together a simple earthquake simulator in Iodide.  This can be found at:

https://brendanjmeade.github.io/rs-interactive.html

While there's nothing technically or scientifically new here, there are lots of interesting nonlinearities that can be interactively explored here.  Right now browser's complain about it loading an insecure script...so I've got figure that out...web stuff is all new to me.

I just thought I'd share something I created with Iodide!

Brendan

[brendan c.]

Hi Brendan, this notebook is great! May we add it to our iodide-examples repo?

Also, just our of curiosity: how did you come across Iodide? We're always interested in how people learn about the project since we have yet to do any real publicity around it :-)

The notebook seems to be working fine on my end (I'm not getting any insecure script warnings). If you run into any trouble, please feel free to reach out to ask questions, we're happy to help. And of course, github issues regarding bugs and feature requests are always welcome as well!

Thanks!

-brendan c.