Skip to content

Commit

Permalink
Merge pull request #110 from phyloref/add-binder-note
Browse files Browse the repository at this point in the history
This PR adds a note to the tutorials README to note that Binder cannot be used as per #102 (comment).
  • Loading branch information
gaurav authored Sep 1, 2021
2 parents af54984 + 27f1ed3 commit a4ed4d0
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion tutorials/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,11 @@ files using [IJavascript] as a Node.js kernel. A [Makefile] is included that can
to build Markdown and PDF versions of these tutorials, using [Jupyter nbconvert] and
[pandoc]. We use the [eisvogel] LaTeX template as the template for our PDF.

While these Jupyter Notebooks can be viewed in [Jupyter nbviewer], note that they cannot
be opened with [Binder], since they use an unsupported IJavascript kernel (see [related issue]).

Currently available tutorials:
- [Introduction.ipynb] - An introduction to phyx.js ([Introduction.md], [Introduction.pdf])
- [Introduction.ipynb] - An introduction to phyx.js ([Introduction.md], [Introduction.pdf], [Introduction in nbviewer])


[Jupyter Notebook]: https://jupyter.org/
Expand All @@ -18,6 +21,10 @@ Currently available tutorials:
[Jupyter nbconvert]: https://nbconvert.readthedocs.io/
[pandoc]: https://pandoc.org/
[eisvogel]: https://github.com/Wandmalfarbe/pandoc-latex-template/
[Jupyter nbviewer]: https://nbviewer.jupyter.org/github/phyloref/phyx.js/tree/master/tutorials/
[Binder]: https://mybinder.org/
[related issue]: https://github.com/phyloref/phyx.js/issues/105
[Introduction.ipynb]: ./Introduction.ipynb
[Introduction.md]: ./Introduction.md
[Introduction.pdf]: ./Introduction.pdf
[Introduction in nbviewer]: https://nbviewer.jupyter.org/github/phyloref/phyx.js/tree/master/tutorials/Introduction.ipynb

0 comments on commit a4ed4d0

Please sign in to comment.