Library Carpentry für die Bibliothek

Workshop des VDB-Regionalverbands Südwest an der Badischen Landesbibliothek

26.-27. Juni 2019

9:30 am

Instructors: Katrin Leinweber (TIB), Till Sauerwein (ZB MED), Ralf Weber (BLB Karlsruhe)

Helpers: Thomas Gerd tom Markotten (PH-Bibliothek Freiburg), Linna Lu (TIB)

General Information

Library Carpentry is made by librarians, for librarians to help you:

Library Carpentry introduces you to the fundamentals of computing and provides you with a platform for further self-directed learning. For more information on what we teach and why, please see our paper "Library Carpentry: software skills training for library professionals".

Who: The course is for librarians, archivists, and other information workers. You don't need to have any previous knowledge of the tools that will be presented at the workshop. Maximum number of participants: 20.

Where: Erbprinzenstraße 15, 76133, Karlsruhe. Get directions with OpenStreetMap or Google Maps.

Room: Stober-Werkstatt (EG) im Wissenstor

When: 26.-27. Juni 2019. Add to your Google Calendar.

Requirements: Participants must bring a laptop with a Mac, Linux, or Windows operating system (not a tablet, Chromebook, etc.) that they have administrative privileges on. They should have a few specific software packages installed (listed below). They are also required to abide by Library Carpentry's Code of Conduct.

Accessibility: Materials will be provided in advance of the workshop and large-print handouts are available if needed by notifying the organizers in advance. If we can help making learning easier for you (e.g. sign-language interpreters, lactation facilities) please get in touch (using contact details below) and we will attempt to provide them.

Further information: Participation fee: 60 EUR for members of VDB, BIB or similar, 120 EUR for others (VDB-Regionalverband Südwest, KSK Tübingen, IBAN DE15 6415 0020 0002 6710 59). Catering is included during the workshop. For overnight accomodation (not included) please see Karlsruhe-Tourismus.de. If the participants are interested, a joint dinner is possible at AlteBank.de (not included). Please let us know when you register.

Contact: Please email scheuble@ph-freiburg.de (Robert Scheuble) for more information and gramlich@wlb-stuttgart.de (Maria Gramlich) for registration.


Surveys

Please be sure to complete these surveys before and after the workshop.

Pre-workshop Survey

Post-workshop Survey


Schedule

Day 1

09:30 Data Intro for Librarians
10:30 Coffee
12:00 Lunch break
13:00 Shell Lessons for Libraries
14:30 Coffee
16:00 Wrap-up
16:30 END

Day 2

09:00 Python for Librarians
10:30 Coffee
12:00 Lunch break
13:00 OpenRefine
14:30 Coffee
16:00 Wrap-up
16:30 END

We will use this collaborative document for chatting, taking notes, and sharing URLs and bits of code.


Syllabus

Introduction to Data

  • Intro to data
  • Jargon busting
  • Keyboard shortcuts
  • Plain text formats
  • Naming files
  • Regular expressions
  • Reference...

The Unix Shell

  • Files and directories
  • History and tab completion
  • Counting and sorting contents in files
  • Pipes and redirection
  • Mining or searching in files
  • Reference...

Version Control with Git

  • Creating a repository
  • Configuring git
  • Recording changes to files: add, commit, ...
  • Viewing state changes with status
  • Working on the web: clone, pull, push, ...
  • Where to host work, and why
  • Reference...

OpenRefine

  • Introduction to OpenRefine
  • Importing data
  • Basic functions
  • Advanced Functions
  • Reference...

Setup

To participate in a Library Carpentry workshop, you will need access to the software described below. In addition, you will need an up-to-date web browser.

We maintain a list of common issues that occur during installation as a reference for instructors that may be useful on the Configuration Problems and Solutions wiki page.

The Bash Shell

Bash is a commonly-used shell that gives you the power to do simple tasks more quickly.

Windows

Video Tutorial
  1. Download the Git for Windows installer.
  2. Run the installer and follow the steps below:
    1. Click on "Next" four times (two times if you've previously installed Git). You don't need to change anything in the Information, location, components, and start menu screens.
    2. Select “Use the nano editor by default” and click on “Next”.
    3. Keep "Use Git from the Windows Command Prompt" selected and click on "Next". If you forgot to do this programs that you need for the workshop will not work properly. If this happens rerun the installer and select the appropriate option.
    4. Click on "Next".
    5. Keep "Checkout Windows-style, commit Unix-style line endings" selected and click on "Next".
    6. Select "Use Windows' default console window" and click on "Next".
    7. Click on "Install".
    8. Click on "Finish".
  3. If your "HOME" environment variable is not set (or you don't know what this is):
    1. Open command prompt (Open Start Menu then type cmd and press [Enter])
    2. Type the following line into the command prompt window exactly as shown:

      setx HOME "%USERPROFILE%"

    3. Press [Enter], you should see SUCCESS: Specified value was saved.
    4. Quit command prompt by typing exit then pressing [Enter]

This will provide you with both Git and Bash in the Git Bash program.

macOS

The default shell in all versions of macOS is Bash, so no need to install anything. You access Bash from the Terminal (found in /Applications/Utilities). See the Git installation video tutorial for an example on how to open the Terminal. You may want to keep Terminal in your dock for this workshop.

Linux

The default shell is usually Bash, but if your machine is set up differently you can run it by opening a terminal and typing bash. There is no need to install anything.

Text Editor

When you're writing code, it's nice to have a text editor that is optimized for writing code, with features like automatic color-coding of key words. The default text editor on macOS and Linux is usually set to Vim, which is not famous for being intuitive. If you accidentally find yourself stuck in it, try typing the escape key, followed by :q! (colon, lower-case 'q', exclamation mark), then hitting Return to return to the shell.

Windows

nano is a basic editor and the default that instructors use in the workshop. It is installed along with the Shell and Git.

Others editors that you can use are Notepad++ or Sublime Text. Be aware that you must add its installation directory to your system path. Please ask your instructor to help you do this.

macOS

nano is a basic editor and the default that instructors use in the workshop. See the Shell and Git installation video tutorial for an example on how to open nano. It should be pre-installed.

Others editors that you can use are Text Wrangler or Sublime Text.

Linux

nano is a basic editor and the default that instructors use in the workshop. It should be pre-installed.

Others editors that you can use are Gedit, Kate or Sublime Text.

Python

Python is a popular language for research computing, and great for general-purpose programming as well. Installing all of its research packages individually can be a bit difficult, so we recommend Anaconda, an all-in-one installer.

Regardless of how you choose to install it, please make sure you install Python version 3.x (e.g., 3.6 is fine).

We will teach Python using the Jupyter notebook, a programming environment that runs in a web browser. For this to work you will need a reasonably up-to-date browser. The current versions of the Chrome, Safari and Firefox browsers are all supported (some older browsers, including Internet Explorer version 9 and below, are not).

Windows

Video Tutorial
  1. Open https://www.anaconda.com/download/#windows with your web browser.
  2. Download the Python 3 installer for Windows.
  3. Install Python 3 using all of the defaults for installation except make sure to check Make Anaconda the default Python.

macOS

Video Tutorial
  1. Open https://www.anaconda.com/download/#macos with your web browser.
  2. Download the Python 3 installer for OS X.
  3. Install Python 3 using all of the defaults for installation.

Linux

  1. Open https://www.anaconda.com/download/#linux with your web browser.
  2. Download the Python 3 installer for Linux.
    (The installation requires using the shell. If you aren't comfortable doing the installation yourself stop here and request help at the workshop.)
  3. Open a terminal window.
  4. Type
    bash Anaconda3-
    and then press tab. The name of the file you just downloaded should appear. If it does not, navigate to the folder where you downloaded the file, for example with:
    cd Downloads
    Then, try again.
  5. Press enter. You will follow the text-only prompts. To move through the text, press the space key. Type yes and press enter to approve the license. Press enter to approve the default location for the files. Type yes and press enter to prepend Anaconda to your PATH (this makes the Anaconda distribution the default Python).
  6. Close the terminal window.

OpenRefine

For this lesson you will need OpenRefine and a web browser. Note: this is a Java program that runs on your machine (not in the cloud). It runs inside a web browser, but no web connection is needed.

Windows

  1. Check that you have either the Firefox or the Chrome browser installed and set as your default browser. OpenRefine runs in your default browser. It will not run correctly in Internet Explorer.
  2. Download software from http://openrefine.org
  3. Create a new directory called OpenRefine.
  4. Unzip the downloaded file into the OpenRefine directory by right-clicking and selecting "Extract ...".
  5. Go to your newly created OpenRefine directory.
  6. Launch OpenRefine by clicking openrefine.exe (this will launch a command prompt window, but you can ignore that - just wait for OpenRefine to open in the browser).
  7. If you are using a different browser, or if OpenRefine does not automatically open for you, point your browser at http://127.0.0.1:3333/ or http://localhost:3333 to use the program.

Mac

  1. Check that you have either the Firefox or the Chrome browser installed and set as your default browser. OpenRefine runs in your default browser. It may not run correctly in Safari.
  2. Download software from http://openrefine.org
  3. Create a new directory called OpenRefine.
  4. Unzip the downloaded file into the OpenRefine directory by double-clicking it.
  5. Go to your newly created OpenRefine directory.
  6. Launch OpenRefine by dragging the icon into the Applications folder. Use Ctrl-click/Open ... to launch it.
  7. If you are using a different browser, or if OpenRefine does not automatically open for you, point your browser at http://127.0.0.1:3333/ or http://localhost:3333 to use the program.

Linux

  1. Check that you have either the Firefox or the Chrome browser installed and set as your default browser. OpenRefine runs in your default browser.
  2. Download software from http://openrefine.org
  3. Create a new directory called OpenRefine.
  4. Unzip the downloaded file into the OpenRefine directory by double-clicking it.
  5. Go to your newly created OpenRefine directory.
  6. Launch OpenRefine by entering ./refine into the terminal within the OpenRefine directory. If you are using a different browser, or if OpenRefine does not automatically open for you, point your browser at http://127.0.0.1:3333/ or http://localhost:3333 to use the program.