Compatibility between Jupyter Notebooks / Binder and DAR / Texture / Stencila

nuest commented 6 years ago

[ Project Contact ] @minrk, @nuest [ GitHub Repo ] https://github.com/minrk/jupyter-dar [ Track ] Openness, [ Location ] Cambridge UK, BST [ Coach ] @chadsansing

Description

Binder is an online service for running Jupyter Notebooks and other environments. Texture/Stencila are editors for reproducible research documents. We want to connect them so that users can edit reproducible documents (DAR files) as part of a binder project.

Objectives: Understanding DAR Launching Stencila Editor on Binder (potentially not launching anything else, i.e. w/o the Jupyter Notebook start page) repo2docker support for DAR files

Want to contribute to this project during #mozsprint?

Join us at the Global Sprint, May 10-11. Leave a comment below if you're interested in contributing to this project during #mozsprint 2018!

Note to the Project Lead :tada:

Congrats, @minrk, nuest! This is your official project listing for the Mozilla Global Sprint 2018. To confirm your registration, please complete and check off the following:

[x] Complete Open Leadership 101
[x] Provide a GitHub repository for work and discussion on your project (in a comment or at the top of this issue)
[x] Create a README file in your project repository. This file should help newcomers understand what your project is, why it's important, and kinds of help you're looking for.
[x] Create file: LICENSE to give your project an open license, allowing for sharing and remixing.
[ ] Turn on your Issue Tracker and create at least three issues to describe each task that you need help with and how a contributor can get started on that task.
[ ] Create a label called mozsprint and apply it to your issues.:

If you get stuck at any point, feel free to look at the requirements page and project templates or reach out to your Project Coach, @chadsansing. We're here to help you through this process.

nuest commented 6 years ago

:tada: First demo works!

nuest commented 6 years ago

The project had some world-wide contribution. "Over night" the Stencila devs (@nokome) worked on running Jupyter contexts and contributed some code: https://github.com/minrk/jupyter-dar/pull/5

Read more at the Stencila Community: https://community.stenci.la/t/stencila-in-binder/142

And here is the direct link to a working example: https://mybinder.org/v2/gh/nokome/jupyter-dar/add-stencila-host?urlpath=%2Fstencila%2F

nuest commented 6 years ago

Since @stencila people are now helping out, chat about the project takes place at https://gitter.im/stencila/stencila

nuest commented 6 years ago

I am currently trying to get the R context working... found a mismatch in confguration file paths (see https://github.com/stencila/r/pull/22) and the RContext is listed in Stencila

and errors are gone, but the code is not evaluated yet...

The error is

[E 10:39:53.361 NotebookApp] 500 POST /stencila-host/RContext (172.17.0.1) 6.96ms referer=http://localhost:8888/stencila/?archive=r-markdown

nuest commented 6 years ago

Status report

We have stopped working on getting R to work - see https://github.com/minrk/jupyter-dar/issues/9 (but did find a bug too: https://github.com/stencila/r/pull/22); we need help from the Stencila experts for that, but there's other stuff to do...
@nuest works on packaging the proxy as a proper Python module, which will make installation and maintenance easier down the road (base on https://github.com/jupyterhub/nbrsessionproxy)
@minrk works on getting https://github.com/jupyter/repo2docker ready to handle repos with Dar archives - the Docker image generation will be like magix :unicorn:

nuest commented 6 years ago

The Python module for the proxy also allows us to extend the Jupyter landing page with a nice button (https://github.com/minrk/jupyter-dar/issues/1):

nuest commented 6 years ago

Demo works (on an inofficial binder website) :tada: :100:

Try it at http://binder.minrk.net/v2/gh/minrk/jupyter-dar/master?urlpath=%2Fstencila%2F

jupyter-dar-01

npscience commented 6 years ago

@nuest many thanks for documenting your progress here, it's fab to have this record and all the links :100:

nuest commented 6 years ago

The software is ready for this to work on mybinder.org, we're working on some examples and a wrap-up blog post, see https://github.com/minrk/nbstencilaproxy/issues/12

nuest commented 6 years ago

@chadsansing If you're still "coaching" this, feedback on a wrap-up blog post is very welcome: https://github.com/minrk/nbstencilaproxy/issues/12#issuecomment-435974747

nuest commented 6 years ago

The wrap-up blog post is now online at

https://elifesciences.org/labs/d42fe2b9/integrating-binder-and-stencila-the-building-blocks-to-increased-open-communication-and-transparency

Some cross-posts will happen during the coming days, see https://github.com/minrk/nbstencilaproxy/issues/12 for links.

npscience commented 6 years ago

Fantastic read, I learnt so much about what actually happened with this project and what each of you did (although not all technical details absorbed, but that's ok for me 😄). Thank you!! :100:

PreetiSharmaCareerGuide commented 3 years ago

Very nice article! I'm Preeti, I write for educational blogs. I make a collection of wonderful educational blogs from where I could take inspiration for writing. This article really inspires me though it is a little different from my domain but nonetheless it is a good writing. I sometime write for a education site blogs www.clearexam.ac.in Let me know your thoughts if I could contribute to your blog too.

nitijain123 commented 3 years ago

This is a wonderful article. I can see that you have done a lot of research and your subject knowledge is good and impressive. This is Nitin, I also like to write for an education blog www.cleariitmedical.com - This is an online blog for students who want to prepare for India's most difficult entrance exams - IIT JEE and NEET This is a free blog and provide free study material, quiz and notes to those who can't afford to pay hefty fees of coaching institutes. I write free of cost for the good cause. I know you must be busy with your work but if you could take out some time from your busy schedule and have a look at it. I saw a good collection of articles. If you only write a few words about this blog then it can help a lot of students out there. Thanks!

Meghabms commented 3 years ago

Wow! Such an articulative post it is! I am a fan of your writing. Being a new writer, it's always good to see inspiring posts like this. I am a management graduate and write for 12th pass students for various career options. I write for a good blog: www.clearlawentrance.com I want to write about a lot of things out there, please guide me on how I can become a good blogger.

Smritiwalia1 commented 3 years ago

Hey, it's Smriti. Your article is a good one. I must say not everybody knows how to write blogs and make them look professional. Being a law student I always look for data points like charts, analysis in articles. Yours seems to give justice to the topic. My personal style includes a lot of graphs, numbers and informative videos. I write on www.successmantra.com for law related exams.

mozilla / global-sprint