Skip to content

Commit

Permalink
Added some text to everything
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewbellis committed Jul 8, 2024
1 parent e2f4551 commit a7da20b
Show file tree
Hide file tree
Showing 9 changed files with 104 additions and 100 deletions.
7 changes: 4 additions & 3 deletions config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ carpentry: 'incubator'
varnish: 'cms-opendata-workshop/varnish'

# Overall title for pages.
title: 'Lesson Title' # FIXME
title: 'Particle Physics Primer' # FIXME

# Date the lesson was created (YYYY-MM-DD, this is empty by default)
created: ~ # FIXME
created: ~ # 2024-07-08

# Comma-separated list of keywords for the lesson
keywords: 'software, data, lesson, CMS' # FIXME
keywords: 'software, data, lesson, CMS, particle physics, physics' # FIXME

# Life cycle stage of the lesson
# possible values: pre-alpha, alpha, beta, stable
Expand Down Expand Up @@ -64,6 +64,7 @@ contact: '[email protected]' # FIXME
# Order of episodes in your lesson
episodes:
- introduction.md
- 02-videos.md

# Information for Learners
learners:
Expand Down
68 changes: 68 additions & 0 deletions episodes/02-videos.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
title: "Videos for the general public"
teaching: XXX
exercises: YYY
---

:::::::::::::::::::::::::::::::::::::: questions

- What is the LHC?
- What is CERN?
- What is the CMS experiment?
- What are we trying to do at these experiments?

::::::::::::::::::::::::::::::::::::::::::::::::

::::::::::::::::::::::::::::::::::::: objectives

- Explain how to use markdown with The Carpentries Workbench
- Demonstrate how to include pieces of code, figures, and nested challenge blocks

::::::::::::::::::::::::::::::::::::::::::::::::

## Videos

### The CMS experiment

A nice overview of the CMS experiment from the [CMS experiment's YouTube channel](https://www.youtube.com/@CMSExperiment).
If you only watch one of these videos, this is the one!

![[Introducing the CMS experiment at CERN](https://www.youtube.com/watch?v=EB5eZIR3AoM)](fig/intro_cms_YT.jpeg){alt="Photograph of the CMS experiment."}

### The LHC

A oldie, but a goodie. A discussion of the Large Hadron Collider, by Don Lincoln of Fermilab. You can find more of his videos
over on [Fermilab's YouTube channel](https://www.youtube.com/@fermilab).

![[LHC: The Large Hadron Collider](https://www.youtube.com/watch?v=debQ60QVtYQ)](fig/don_lincoln_lhc.jpeg){alt="Photograph of Don Lincoln and the words LHC: the Large Hadron Collider."}

### What are we doing and what comes next?

A discussion of what CERN and the LHC experiments have accomplished and what comes next?
From Cleo Abram's [YouTube science popularizing channel "Huge if true"](https://www.youtube.com/@CleoAbram).

![[What's really happening at CERN?](https://www.youtube.com/watch?v=bCmwCkNY85g)](fig/cleo_abram_CERN.jpeg){alt="Photograph of Cleo Abram and the words Did We Do It"}

### Watch a movie!

If you have time, grab some family and friends and watch [Particle Fever](https://www.imdb.com/title/tt1385956/), the 2013 documentary
about the discovery of the Higgs Boson.

From Wikipedia:

Particle Fever is a 2013 American documentary film tracking the first round of experiments at the Large Hadron Collider (LHC) near Geneva, Switzerland. The film follows the experimental physicists at the European Organization for Nuclear Research (CERN) who run the experiments, as well as the theoretical physicists who attempt to provide a conceptual framework for the LHC's results. The film begins in 2008 with the first firing of the LHC and concludes in 2012 with the successful identification of the Higgs boson



![[What's really happening at CERN?](https://www.youtube.com/watch?v=bCmwCkNY85g)](fig/particle_fever.jpg){alt="Advertisement for the documentary movie Particle Fever"}

::::::::::::::::::::::::::::::::::::: keypoints

- Use `.md` files for episodes when you want static content
- Use `.Rmd` files for episodes when you need to generate output
- Run `sandpaper::check_lesson()` to identify any issues with your lesson
- Run `sandpaper::build_lesson()` to preview your lesson locally

::::::::::::::::::::::::::::::::::::::::::::::::

[r-markdown]: https://rmarkdown.rstudio.com/
Binary file added episodes/fig/cleo_abram_CERN.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added episodes/fig/don_lincoln_lhc.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added episodes/fig/intro_cms_YT.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added episodes/fig/particle_fever.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
68 changes: 17 additions & 51 deletions episodes/introduction.md
Original file line number Diff line number Diff line change
@@ -1,76 +1,42 @@
---
title: "Using Markdown"
title: "Introduction"
teaching: 10
exercises: 2
---

:::::::::::::::::::::::::::::::::::::: questions

- How do you write a lesson using Markdown and `{sandpaper}`?
- What is particle physics?
- What is happening at the LHC?

::::::::::::::::::::::::::::::::::::::::::::::::

::::::::::::::::::::::::::::::::::::: objectives

- Explain how to use markdown with The Carpentries Workbench
- Demonstrate how to include pieces of code, figures, and nested challenge blocks
- Develop a very broad overview of what particle physics is
- Develop a very broad overview of what takes place at CERN and the LHC

::::::::::::::::::::::::::::::::::::::::::::::::

## Introduction
# Introduction

This is a lesson created via The Carpentries Workbench. It is written in
[Pandoc-flavored Markdown](https://pandoc.org/MANUAL.txt) for static files and
[R Markdown][r-markdown] for dynamic files that can render code into output.
Please refer to the [Introduction to The Carpentries
Workbench](https://carpentries.github.io/sandpaper-docs/) for full documentation.
Particle physics is an broad field which focuses on the study of the very smallest particles. Even
smaller than atoms!

What you need to know is that there are three sections required for a valid
Carpentries lesson:
If you only had 5 minutes to learn about particle physics and wanted the simplest explanation possible,
you could do worse than the [Simple Wikipedia entry for "Particle Physics"](https://simple.wikipedia.org/wiki/Particle_physics).

1. `questions` are displayed at the beginning of the episode to prime the
learner for the content.
2. `objectives` are the learning objectives for an episode displayed with
the questions.
3. `keypoints` are displayed at the end of the episode to reinforce the
objectives.
If you only had more time and could handle a higher level of discussion, a good starting point is
the [standard Wikipedia entry for "Particle Physics"](https://en.wikipedia.org/wiki/Particle_physics).

:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: instructor
You probably want more though, so we'll provide some videos that go into a bit more detail about the specific topics
that the LHC (Large Hadron Collider) experiments focus on. We'll start with some videos intended for the general public,
then go into some lectures by one of our collaborators, [Dr. Allison Hall](https://www.usna.edu/Users/physics/hall/index.php),
and then end with some basic computing challenges that walk you through a toy example of discovering particles.

Inline instructor notes can help inform instructors of timing challenges
associated with the lessons. They appear in the "Instructor View"
First, some fun videos!

::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::

::::::::::::::::::::::::::::::::::::: challenge

## Challenge 1: Can you do it?

What is the output of this command?

```r
paste("This", "new", "lesson", "looks", "good")
```

:::::::::::::::::::::::: solution

## Output

```output
[1] "This new lesson looks good"
```

:::::::::::::::::::::::::::::::::


## Challenge 2: how do you nest solutions within challenge blocks?

:::::::::::::::::::::::: solution

You can add a line with at least three colons and a `solution` tag.

:::::::::::::::::::::::::::::::::
::::::::::::::::::::::::::::::::::::::::::::::::

## Figures

Expand Down
10 changes: 9 additions & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,15 @@
site: sandpaper::sandpaper_site
---

This is a new lesson built with [The Carpentries Workbench][workbench].
This lesson provides resources for you to learn about particle physics. It is not a
complete overview and depending on your level, you may need to review some introductory
physics concepts.

We hope this is a solid jumping-off-point for anyone new to this field and that it gives you
the necessary background to get the most out of this workshop.

If you feel there are other materials that could be useful to future participants,
please email the organizers (see *Contact* link at bottom of this page).


[workbench]: https://carpentries.github.io/sandpaper-docs
Expand Down
51 changes: 6 additions & 45 deletions learners/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,53 +2,14 @@
title: Setup
---

FIXME: Setup instructions live in this document. Please specify the tools and
the data sets the Learner needs to have installed.
## Setup

## Data Sets
For this lesson, you primarily need to have a computer with access to the internet and
the requisite audio/video capabilities to watch/listen to YouTube videos.

<!--
FIXME: place any data you want learners to use in `episodes/data` and then use
a relative link ( [data zip file](data/lesson-data.zip) ) to provide a
link to it, replacing the example.com link.
-->
Download the [data zip file](https://example.com/FIXME) and unzip it to your Desktop
You will get the most out of this lesson if you also

## Software Setup
- Attempt some of the problems presented in the video lectures
- Use [Google Colab](https://colab.research.google.com/) to try out some simple python problem sets.

::::::::::::::::::::::::::::::::::::::: discussion

### Details

Setup for different systems can be presented in dropdown menus via a `spoiler`
tag. They will join to this discussion block, so you can give a general overview
of the software used in this lesson here and fill out the individual operating
systems (and potentially add more, e.g. online setup) in the solutions blocks.

:::::::::::::::::::::::::::::::::::::::::::::::::::

:::::::::::::::: spoiler

### Windows

Use PuTTY

::::::::::::::::::::::::

:::::::::::::::: spoiler

### MacOS

Use Terminal.app

::::::::::::::::::::::::


:::::::::::::::: spoiler

### Linux

Use Terminal

::::::::::::::::::::::::

0 comments on commit a7da20b

Please sign in to comment.