Create a gallery of interesting books

[choldgraf]

We should create a gallery of interesting Jupyter Books that the community can use as inspiration (and to highlight both Jupyter Book and the other projects). A few quick ideas:

• We could take a list of public repositories (and optionally paths to a book within those repositories) in a YAML file

  • For each one, use a logo file defined in _config.yml to display a logo
  • We also need the URL of the deployed book for that repository

• We have a repository at executablebooks/gallery that runs a GitHub action that loops through these books and programmatically builds up a sphinx-pannels gallery of links that people can click

• Any new PR that's merged to this repo will auto-update the gallery

• Who decides what books are in the gallery? (a few options)

  • We hand-pick books
  • We ask users to self-select and accept them all
  • We have a publicly-editable list that others can add to
  • We come up with something fancy like "open an issue with a template that asks you to provide information" and we either choose 👍 or 👎 , or ask others to upvote the issue and above some threshold the repository is displayed

Short-list of books to display

• Quantitative Economics book by mysteriously unknown but clearly talented authors
• Intro to DS/Stats as part of a course at NYU

[chrisjsewell]

yeh I think initially we can hand pick some, to get going, then people can make PRs; updating the list of repositories with their own, and we moderate whether to allow them (generally just a cursory check of the site URL).
Then probably ordering them by the number of stars on the repo would be simplest, and/or you could get more intricate, by e.g. "spotlighting" new repositories added (even if they have no stars), just for a few days or so

[choldgraf]

that sounds good to me - do you know of any books out there to hand-pick from? Or shall I try to blast twitter or something?

[jstac]

Just stumbled across this one, never heard of the authors but it looks like great quality.

Seriously, in the admonition/tip "Get Involved with Jupyter Book", perhaps add an item asking for contributions to a gallery?

[choldgraf]

haha :-)

re: adding it to the front page, I think that's a great idea! Once we figure out a pattern for others to follow then we can share it there.

[choldgraf]

another cool one from a friend of mine at NYU: https://cranmer.github.io/stats-ds-book/

[jmason86]

Us (@mbobra) too, maybe! helioml.org

[choldgraf]

definitely! (though y'all should upgrade to the latest jupyter book!)

[jmason86]

That's the plan. A bunch of stuff broke when we tried last week and we haven't gone back to debug yet.

[chrisjsewell]

FYI, this is somewhat equivalent to how we handle plugins in AiiDA: https://github.com/aiidateam/aiida-registry: they make a PR which triggers a number of tests on their repo, to check which version of aiida-core they support etc, then when the PR is merged it triggers the documentation build to include their plugin in the registered list: https://aiidateam.github.io/aiida-registry/

[choldgraf]

ah yes that looks fantastic! Basically I think we just want that + a image preview for each book (either a logo or somehow grab a screenshot of their front page)

[jstac]

I agree, that looks great. If the image is hard then I reckon we should just go ahead with a title and authors, setting the issue of images aside for now.

[choldgraf]

Title and authors I think should be easy - if there's a logo that shouldn't be too hard either (since a logo path + a URL means we should just be able to link externally for the image)...but a screenshot might be tricky

[TomasBeuzen]

A few others I've come across:

• Python Packaging book: Py-Pkgs (disclaimer that this is my own work and not the latest JB yet - working on it!)
• The Climate Laboratory Book
• Geographic Data Science with PySAL and the PyData Stack
• Computational and Inferential Thinking
• We also recently used JB to host a "virtual conference" at the Univ. British Columbia, but this is a more ephemeral example.

[choldgraf]

another cool one I just noticed from @melaniewalsh! https://melaniewalsh.github.io/Intro-Cultural-Analytics

[bknaepen]

Our group has put online its first Jupyter Book. It's still work in progress as it's the first year this course is taught and we add material on a bi-weekly basis. Jupyter Book is really convienent to collect our notebooks in an easy to navigate website for the students. Thanks for all the great work !

https://aquaulb.github.io/book_solving_pde_mooc/

[jstac]

That PDE book is really nice @bknaepen -- definitely should be in the gallery.

[thomasfermi]

Hi everybody. I am just gonna do shameless self-promotion and mention my Jupyter Book on Algorithms for Automated Driving.

I really enjoy using Jupyter Book. The recent addition of tabs was awesome. I used tabs to

• let the students choose how many hints they want for an exercise
• let the students see how a figure changes when a parameter is changed (could be done with matplotlib anim I guess, but I generated that figure with tikz)

[choldgraf]

I've added a PR for a gallery in #181 - I believe that I've added all of the books here that were using the new Jupyter Book version (@jmason86 ping when helioML is added and then we can add it to the list!)