Onboarding 2

onboarding
software carpentry
quarto
collaboration
An introduction to working at UCLHAL

Aim

You are going to create your user own user page, and publish that to the HySchool website.

Pre-requisites

You have completed Lesson 1 (see Lesson 1)

Lesson plan

  1. Set-up
  2. Install Quarto (our documentation and website system) <-- you are here
  3. Write and publish your first page

Please note that this readme.md file will change as we progress through the lessons. You will need to come back here after each step.

Lesson 2: Install Quarto

First

  • confirm you know where your repo is Repository > Show in Finder on your machine
  • open VS Code and go to File > Open Folder… (or equivalent on Windows) and open the folder above

This lesson will show you how to get the HySchool website running on your own machine. To do this we need to run through the Quarto set-up process.

Go to Quarto and follow the Get Started instructions. We’re going to assume you’re using the VS Code getting started tutorial.

You will also need to

  • check you having a working Python installation
  • Set-up a Python (or Conda) virtual environment (Optional but extra credit)
  • install several extensions for VS Code including

Detour (possibly important)

Quarto ‘Hello World’

Go to your shell and install the necessary Python packages. They may already be there if you installed Anaconda.

python3 -m pip install jupyter matplotlib plotly_express

If you run into trouble you may need to quit and re-open VSCode and the Terminal to ensure that everything is properly configured.

You must use python > select interpreter in VSCode (see https://code.visualstudio.com/docs/python/environments#_select-and-activate-an-environment) else it will continue to default to the base setting and not run the Quarto preview etc commands using the right Python interpreter.