Merge branch 'main' of github.com:hsf-training/hsf-training-databases…

…-basics
hsf-training · Oct 24, 2023 · 462a858 · 462a858
2 parents fac518e + eb7d8e6
commit 462a858
Show file tree

Hide file tree

Showing 16 changed files with 160 additions and 120 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -0,0 +1,26 @@
+{
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": false,
+  "commitType": "docs",
+  "commitConvention": "angular",
+  "contributors": [
+    {
+      "login": "panta-123",
+      "name": "Anil Panta",
+      "avatar_url": "https://avatars.githubusercontent.com/u/47672624?v=4",
+      "profile": "https://github.com/panta-123",
+      "contributions": [
+        "content"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7,
+  "skipCi": true,
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "projectName": "hsf-training-databases-basics",
+  "projectOwner": "hsf-training"
+}
diff --git a/README.md b/README.md
@@ -1,4 +1,7 @@
 [![HSF Training Center][training-center-badge]][hsf-training-center]
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
 [![Upcoming Events][schools-badge]][schools]
 [![Twitter Follow][twitter-badge]][twitter]
 
@@ -14,11 +17,11 @@
 > Click [here](https://hsf-training.github.io/hsf-training-databases-basics/) for the training website!
 
 
-Introduction to databases with application in HEP and Nuclear Physics
+Introduction to databases with applications in HEP and Nuclear Physics
 
 ## 📅 Past events and videos
 
-* 🎥 [Fixme Sample event Dec 1 - 13, 2022](https://indico.cern.ch/)
+* ⛏️ [Kick-off! October 23, 2023](https://indico.cern.ch/event/1338915/overview)
 
 Emoji key: 🎥 (full video recordings availabile), ⛏️ (hackathon)
 
@@ -70,6 +73,14 @@ the content of the lesson:
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/panta-123"><img src="https://avatars.githubusercontent.com/u/47672624?v=4?s=100" width="100px;" alt="Anil Panta"/><br /><sub><b>Anil Panta</b></sub></a><br /><a href="#content-panta-123" title="Content">🖋</a></td>
+    </tr>
+  </tbody>
+</table>
+
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
 
@@ -93,3 +104,16 @@ Instead, all regular contributors are listed on our [HSF Training Community page
 [schools-badge]: https://img.shields.io/badge/upcoming%20events-browse-ff69b4
 [twitter-badge]: https://img.shields.io/twitter/follow/hsftraining?style=social
 [twitter]: https://twitter.com/hsftraining
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
diff --git a/_config.yml b/_config.yml
@@ -16,7 +16,7 @@ title: "Introduction to Databases for HEP"
 # Life cycle stage of the lesson
 # See this page for more details: https://cdh.carpentries.org/the-lesson-life-cycle.html
 # Possible values: "pre-alpha", "alpha", "beta", "stable"
-life_cycle: "beta"
+life_cycle: "pre-alpha"
 
 #------------------------------------------------------------
 # Generic settings (should not need to change).

diff --git a/_episodes/01-introduction.md b/_episodes/01-introduction.md
@@ -3,24 +3,26 @@ title: "Introduction"
 teaching: 60
 exercises: 30
 questions:
-- "Why to use Matplotlib for HEP?"
-- "What kind of plots can be done?"
+- "What is a database management system and why it is a good idea to use one?"
+- "What are the differences between relational and non-relational databases?"
 objectives:
-- "Understand the basics of Matplotlib"
-- "Learn how to manipulate the elements of a plot"
-keypoints:
-- "Matplotlib graphs data in Figures, each of which can contain components that can be manipulated: axis, legend, labels, etc."
-- "Many kinds of plots can be produced: scatter plots, bar plots, pie charts, and many more"
+- "Understand the concepts of a database management system"
+- "Learn about common database management systems used in HEP and Nuclear Physics"
+- keypoints:
+- ""
+- ""
 ---
-The example-based nature of [Matplotlib documentation](https://matplotlib.org/) is GREAT.
 
-Matplotlib is the standard when it comes to making plots in Python. It is versatile and allows for lots of functionality and different ways to produce many plots.
-We will be focusing on using matplotlib for High Energy Physics.
+# What is a database?
 
-# A simple example
+A database is a collection of data stored in a computer system. The data is typically organized to model relevant
+characteristics of the information contained in the database.
+For example, a database that contains information on members of a collaboration might be organized to model
+the institutions they belong to, and the publications they have authored, the relationships between the members, etc.
 
-As with any Python code it is always good practice to import the necessary libraries as a first step.
+# Database management systems
 
-```python
-import matplotlib.pyplot as plt
-```
+A database management system (DBMS) is a computer software application that interacts with the user, other applications,
+and the database itself to capture and analyze data.
+
+A general-purpose DBMS is designed to allow the definition, creation, querying, update, and administration of databases.
diff --git a/_episodes/02-sql-basics.md b/_episodes/02-sql-basics.md
@@ -1,16 +1,16 @@
 ---
-title: "Introduction"
+title: "MySQL basics"
 teaching: 60
 exercises: 30
 questions:
-- "Why to use Matplotlib for HEP?"
-- "What kind of plots can be done?"
+- ""
+- ""
 objectives:
-- "Understand the basics of Matplotlib"
-- "Learn how to manipulate the elements of a plot"
+- ""
+- ""
 keypoints:
-- "Matplotlib graphs data in Figures, each of which can contain components that can be manipulated: axis, legend, labels, etc."
-- "Many kinds of plots can be produced: scatter plots, bar plots, pie charts, and many more"
+- ""
+- ""
 ---
 The example-based nature of [Matplotlib documentation](https://matplotlib.org/) is GREAT.
 

diff --git a/_episodes/03-break.md b/_episodes/03-break.md
@@ -0,0 +1,10 @@
+---
+title: "Coffee break"
+teaching: 0
+exercises: 15
+questions:
+- "Get up, stretch out, and dance!"
+objectives:
+- "Refresh your mind!"
+
+{% include links.md %}
diff --git a/_episodes/03-coffee-break.md b/_episodes/03-coffee-break.md
diff --git a/_episodes/04-mysql-and-python.md b/_episodes/04-mysql-and-python.md
@@ -1,16 +1,16 @@
 ---
-title: "Introduction"
+title: "MySQL and Python"
 teaching: 60
 exercises: 30
 questions:
-- "Why to use Matplotlib for HEP?"
-- "What kind of plots can be done?"
+- ""
+- ""
 objectives:
-- "Understand the basics of Matplotlib"
-- "Learn how to manipulate the elements of a plot"
+- ""
+- ""
 keypoints:
-- "Matplotlib graphs data in Figures, each of which can contain components that can be manipulated: axis, legend, labels, etc."
-- "Many kinds of plots can be produced: scatter plots, bar plots, pie charts, and many more"
+- ""
+- ""
 ---
 The example-based nature of [Matplotlib documentation](https://matplotlib.org/) is GREAT.
 

diff --git a/_episodes/05-mysql-queries.md b/_episodes/05-mysql-queries.md
@@ -1,16 +1,16 @@
 ---
-title: "Introduction"
+title: "A bit more on queries"
 teaching: 60
 exercises: 30
 questions:
-- "Why to use Matplotlib for HEP?"
-- "What kind of plots can be done?"
+- ""
+- ""
 objectives:
-- "Understand the basics of Matplotlib"
-- "Learn how to manipulate the elements of a plot"
+- ""
+- ""
 keypoints:
-- "Matplotlib graphs data in Figures, each of which can contain components that can be manipulated: axis, legend, labels, etc."
-- "Many kinds of plots can be produced: scatter plots, bar plots, pie charts, and many more"
+- ""
+- ""
 ---
 The example-based nature of [Matplotlib documentation](https://matplotlib.org/) is GREAT.
 

diff --git a/_episodes/06-sqllite.md b/_episodes/06-sqllite.md
@@ -1,16 +1,16 @@
 ---
-title: "Introduction"
+title: "SQLite"
 teaching: 60
 exercises: 30
 questions:
-- "Why to use Matplotlib for HEP?"
-- "What kind of plots can be done?"
+- ""
+- ""
 objectives:
-- "Understand the basics of Matplotlib"
-- "Learn how to manipulate the elements of a plot"
+- ""
+- ""
 keypoints:
-- "Matplotlib graphs data in Figures, each of which can contain components that can be manipulated: axis, legend, labels, etc."
-- "Many kinds of plots can be produced: scatter plots, bar plots, pie charts, and many more"
+- ""
+- ""
 ---
 The example-based nature of [Matplotlib documentation](https://matplotlib.org/) is GREAT.
 

diff --git a/_episodes/07-break.md b/_episodes/07-break.md
@@ -0,0 +1,10 @@
+---
+title: "Coffee break"
+teaching: 0
+exercises: 15
+questions:
+- "Get up, stretch out, and dance!"
+objectives:
+- "Refresh your mind!"
+
+{% include links.md %}
diff --git a/_episodes/07-coffee-break.md b/_episodes/07-coffee-break.md
diff --git a/_episodes/08-intro-nosql.md b/_episodes/08-intro-nosql.md
@@ -1,16 +1,16 @@
 ---
-title: "Introduction"
+title: "Introduction to NoSQL"
 teaching: 60
 exercises: 30
 questions:
-- "Why to use Matplotlib for HEP?"
-- "What kind of plots can be done?"
+- ""
+- ""
 objectives:
-- "Understand the basics of Matplotlib"
-- "Learn how to manipulate the elements of a plot"
+- ""
+- ""
 keypoints:
-- "Matplotlib graphs data in Figures, each of which can contain components that can be manipulated: axis, legend, labels, etc."
-- "Many kinds of plots can be produced: scatter plots, bar plots, pie charts, and many more"
+- ""
+- ""
 ---
 The example-based nature of [Matplotlib documentation](https://matplotlib.org/) is GREAT.
 

diff --git a/_episodes/09-nosql-queries.md b/_episodes/09-nosql-queries.md
@@ -1,16 +1,16 @@
 ---
-title: "Introduction"
+title: "NoSQL queries"
 teaching: 60
 exercises: 30
 questions:
-- "Why to use Matplotlib for HEP?"
-- "What kind of plots can be done?"
+- ""
+- ""
 objectives:
-- "Understand the basics of Matplotlib"
-- "Learn how to manipulate the elements of a plot"
+- ""
+- ""
 keypoints:
-- "Matplotlib graphs data in Figures, each of which can contain components that can be manipulated: axis, legend, labels, etc."
-- "Many kinds of plots can be produced: scatter plots, bar plots, pie charts, and many more"
+- ""
+- ""
 ---
 The example-based nature of [Matplotlib documentation](https://matplotlib.org/) is GREAT.
 

diff --git a/_episodes/10-text-based-search.md b/_episodes/10-text-based-search.md
@@ -1,16 +1,16 @@
 ---
-title: "Introduction"
+title: "Text-based search"
 teaching: 60
 exercises: 30
 questions:
-- "Why to use Matplotlib for HEP?"
-- "What kind of plots can be done?"
+- ""
+- ""
 objectives:
-- "Understand the basics of Matplotlib"
-- "Learn how to manipulate the elements of a plot"
+- ""
+- ""
 keypoints:
-- "Matplotlib graphs data in Figures, each of which can contain components that can be manipulated: axis, legend, labels, etc."
-- "Many kinds of plots can be produced: scatter plots, bar plots, pie charts, and many more"
+- ""
+- ""
 ---
 The example-based nature of [Matplotlib documentation](https://matplotlib.org/) is GREAT.