Guidance on Building your own Notebook

Goal

The goal of your notebook is to produce a computational document that engages with GLAM data from Ottawa. It would be helpful - but not required - to coordinate with your peers so that we have a wide variety of final notebooks. But even if two people created notebooks working with the same data, you would in all likelihood go about it in different ways, and so a user/reader would still learn from your example.

The notebook should do something meaningful with the data, with two examples of ‘something meaningful’ within a single notebook, from the same data source:

  • What constitutes a ‘thing’? It could be a visualization of a certain subset of information. It could show how to map the material. It might make the material more easily available. It might do some sort of creative remixing. Other things are possible. See the examples in the wild.
  • What constitutes ‘meaningful’? Well, that’s an argument you would make in full in your Notebook Reflection. But you’d also include a briefer indication within your notebook as well, summarizing what the notebook will do, what data it will work with, and where a user/reader might like to expand or change things or push further.

Requirements

  1. The notebook will have the following subheadings
  • Introduction ~ This section will introduce your goals for the notebook, and briefly situate what your notebook does and why it matters.
  • Data ~ This section will discuss the source of your data, is strengths / limitations, and will include the necessary code to load the data up. The discussion here may be brief; you will want to address the same questions in more depth in your Notebook Reflection.
    • It may well be that you are loading data from some other website; it could be that you’ve already downloaded, subsetted, and cleaned data from somewhere; in this case, you’d be loading the data from your own github repository or Datasette on Heroku.
  • The body of your notebook will have subheadings as appropriate to the tasks you are doing. Each subheading should also include a text block that explains the overall task being done in the section.
  • Code should be commented thoroughly.
  • Conclusion ~ This section will summarize what the reader/user has just accomplished, pointing out those points/places where they might wish to expand or modify to work with their own data.
  • References ~ Citations & links to anything you drew upon to build the notebook.
  • Further Readings ~ links to three resources that will help your reader take your example further or think about it more deeply.
  1. Text blocks should be written using Markdown conventions. Here’s a cheatsheet.

  2. A copy of your notebook should be kept in a Github repo. This repo may be public or private. If it is private, share it with user shawn.graham.

Other Considerations

  1. You should probably be writing the notebook on your own machine, having already installed python and jupyter notebooks locally. You would then lodge copies of your notebook in a repo on Github you’ve created for the task, as you go. These copies can then be launched using Binder for live engagement.
  • Alternatively, you can launch this demo from Binder which is preloaded with Python and R. It might take a few minutes to launch. You can create a new notebook by hitting ‘new’ then under ‘notebook’ select python 3:

  • Another alternative: if you have a google account, you can use the Google colab service to create your notebooks. These can be saved directly to your own gdrive or to your github account, as well as locally. Again, this service will time-out so it is important to save your work frequently to your own machine or gdrive. An advantage of using Colab is that it will give you access to a GPU, which is handy if you are doing anything computationally heavy, like image recognition.
  1. You may wish to collaborate with one of your peers.
  • This collaboration could take the form of co-authoring the notebook and the notebook reflection; in this case, you will also be required to discuss the nature of your collaboration, who did what and why and was this equitable, how you managed conflict, how you organized your time, and what lessons your collaboration might imply for GLAM organizations.
  • Alternatively, you could coordinate your notebooks to work with the same data source to highlight different but complementary aspects. You would then work out an ideal sequence for how the user/reader might engage with the materials. What perspective emerges on the data by using your notebooks?
  • I’m open to other ideas; talk to me.
  1. Even if you’re not formally collaborating with anyone, talk about what’s working, what isn’t, and what troubles you’ve run into in our Discord space. Help each other out. Brainstorm. Share. Kvetch. You are under no obligation to do this work in splendid isolation.
What's on this Page