From f7e286ec53b325c0f8e2b3e788a2a520996c5bec Mon Sep 17 00:00:00 2001 From: Andy Turner Date: Fri, 16 Aug 2024 10:54:41 +0100 Subject: [PATCH 1/2] Adds callout to define dependency. Closes #201 --- episodes/introduction.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/episodes/introduction.md b/episodes/introduction.md index 01c97599..f0eb5bda 100644 --- a/episodes/introduction.md +++ b/episodes/introduction.md @@ -45,6 +45,17 @@ scientific software (or software in general!) for your research. Then, share with your neighbors and try to come up with a list of common gripes or challenges. +:::::::::::::::::::::::::::::::::::::::::::::::::: + +::::::::::::::::::::::::::::::::::::::::: callout + +## What is a software *dependency*? + +We will mention software *dependencies* a lot in this section of the workshop +so it is good to clarify this terms up front. A software dependency is a +relationship between software components where one component relies on the +other to work properly. For example, if a software application uses a library +to query a database, the application depends on that library. :::::::::::::::::::::::::::::::::::::::::::::::::: @@ -66,6 +77,8 @@ or missing piece may stop the whole thing from working or break something that w already running. It's no surprise that this situation is sometimes informally termed **dependency hell**. + + ::::::::::::::::::::::::::::::::::::::: challenge ## Software and Science From 86737cada0f99435cc5a9e4dcef9fc1387b1cf17 Mon Sep 17 00:00:00 2001 From: Jeremy Cohen Date: Fri, 16 Aug 2024 12:19:00 +0100 Subject: [PATCH 2/2] Update episodes/introduction.md - fix typo --- episodes/introduction.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/episodes/introduction.md b/episodes/introduction.md index f0eb5bda..5a8bd6bc 100644 --- a/episodes/introduction.md +++ b/episodes/introduction.md @@ -52,7 +52,7 @@ challenges. ## What is a software *dependency*? We will mention software *dependencies* a lot in this section of the workshop -so it is good to clarify this terms up front. A software dependency is a +so it is good to clarify this term up front. A software dependency is a relationship between software components where one component relies on the other to work properly. For example, if a software application uses a library to query a database, the application depends on that library.