Skip to content

Commit

Permalink
deploy: 63b5950
Browse files Browse the repository at this point in the history
  • Loading branch information
@AidanWiederhold
AidanWiederhold committed Feb 5, 2024
1 parent 8167e77 commit 67334f1
Show file tree
Hide file tree
Showing 61 changed files with 492 additions and 359 deletions.
14 changes: 8 additions & 6 deletions CONDUCT.html
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html5" lang="en">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Contributor Code of Conduct &mdash; LHCb Starterkit Lessons documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/panels.css" type="text/css" />
<link rel="stylesheet" href="_static/starterkit.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="_static/panels.css" />
<link rel="stylesheet" type="text/css" href="_static/starterkit.css" />


<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
Expand Down
14 changes: 8 additions & 6 deletions CONTRIBUTING.html
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html5" lang="en">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Contributing &mdash; LHCb Starterkit Lessons documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/panels.css" type="text/css" />
<link rel="stylesheet" href="_static/starterkit.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="_static/panels.css" />
<link rel="stylesheet" type="text/css" href="_static/starterkit.css" />


<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
Expand Down
14 changes: 8 additions & 6 deletions LICENSE.html
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html5" lang="en">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Instructional Material &mdash; LHCb Starterkit Lessons documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/panels.css" type="text/css" />
<link rel="stylesheet" href="_static/starterkit.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="_static/panels.css" />
<link rel="stylesheet" type="text/css" href="_static/starterkit.css" />


<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
Expand Down
13 changes: 10 additions & 3 deletions _sources/first-analysis-steps/analysis-productions.md.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ The next file needed is a `.yaml` file, which will be used to configure the jobs

```yaml
defaults:
application: DaVinci/v46r4
application: DaVinci/v46r10
wg: Charm
automatically_configure: yes
turbo: no
Expand All @@ -109,7 +109,7 @@ defaults:

Here, the unindented lines are the names of jobs (although `defaults` has a special function), and the indented lines are the options we're applying to those jobs. Using this file will create one job called `2016_MagDown_PromptMC_D02KK`, that will read in data from the provided bookkeeping path. All the options applied under `defaults` are automatically applied to all other jobs - very useful for avoiding repetition. The options we're using here are:

* **application**: the version of DaVinci to use. Here we choose v46r4, the latest for Run 2 at the time of writing (see [here](http://lhcbdoc.web.cern.ch/lhcbdoc/davinci/) to check what versions are available).
* **application**: the version of DaVinci to use. Here we choose v46r10, the latest for Run 2 at the time of writing (see [here](http://lhcbdoc.web.cern.ch/lhcbdoc/davinci/) to check what versions are available).
* **wg**: the working group this production is a part of. Since this is a `$ D^{0} \to K^{-}K^{+} $` decay, we'll set this to `Charm`.
* **inform**: optionally, you can enter your email address to receive updates on the status of your jobs.
* **automatically_configure**: setting this to `yes` is what allowed us to remove all of those configuration lines from the options file. This is very useful when creating productions that use multiple years, or both data and MC.
Expand Down Expand Up @@ -224,8 +224,9 @@ ALWAYS:Results will be available at https://lhcb-analysis-productions.web.cern.c

You can open that link in your browser to view the status of the test jobs (example [here](https://lhcb-analysis-productions.web.cern.ch/pipelines/?id=4791499)). After a few minutes, these should have completed - all being well, you've now successfully submitted your first production!


### Checks
For the start of Run 3 it was requested to add the `Checks` feature to AnalysisProductions. This facilitates offline monitoring by allowing automated simple analysis of tupling output to assist with data quality and early measurements. For now let's stick with some simple ones but for full details you can [check the documentation](https://lhcb-ap.docs.cern.ch/user_guide/creating.html#checks).
For the start of Run 3 it was requested to add the `Checks` feature to AnalysisProductions. This facilitates offline monitoring by allowing automated simple analysis of tupling output to assist with data quality and early measurements. In the output of the CI you may have noticed some Checks already ran. These are default checks run for all productions to perform some basic validation of the production but you can also add your own. For now let's stick with some simple ones but for full details you can [check the documentation](https://lhcb-ap.docs.cern.ch/user_guide/creating.html#checks).

We start by defining the checks we would like to perform. Add the following to your `info.yaml` below the `defaults`:
```python
Expand Down Expand Up @@ -275,6 +276,12 @@ The test will have failed due to the histogram check we defined to fail, remove

{% endcallout %}

{% callout "What about Run 3" %}

By and large the procedure for Run 3 is the same, the major differences are within the DaVinci scripts themselves so are covered by the DaVinci lessons. There are some additional configuration options required (at the time of writing) in the YAML file but your WG liaisons should be able to point you to examples.

{% endcallout %}

{% callout "Next steps for real productions" %}

As mentioned earlier, your test productions for this lesson won't be merged since this is only for practice purposes. If this were a real production, there would be some extra steps to take before merging.
Expand Down
14 changes: 8 additions & 6 deletions first-analysis-steps/README.html
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html5" lang="en">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>First Analysis Steps &mdash; LHCb Starterkit Lessons documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/panels.css" type="text/css" />
<link rel="stylesheet" href="../_static/starterkit.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="../_static/panels.css" />
<link rel="stylesheet" type="text/css" href="../_static/starterkit.css" />


<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
Expand Down
14 changes: 8 additions & 6 deletions first-analysis-steps/add-tupletools.html
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html5" lang="en">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>TupleTools and branches &mdash; LHCb Starterkit Lessons documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/panels.css" type="text/css" />
<link rel="stylesheet" href="../_static/starterkit.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="../_static/panels.css" />
<link rel="stylesheet" type="text/css" href="../_static/starterkit.css" />


<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
Expand Down
28 changes: 19 additions & 9 deletions first-analysis-steps/analysis-productions.html
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html5" lang="en">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Analysis Productions &mdash; LHCb Starterkit Lessons documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/panels.css" type="text/css" />
<link rel="stylesheet" href="../_static/starterkit.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="../_static/panels.css" />
<link rel="stylesheet" type="text/css" href="../_static/starterkit.css" />


<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
Expand Down Expand Up @@ -333,7 +335,7 @@ <h2>Creating your own production<a class="headerlink" href="#creating-your-own-p
<p>If you don’t have your options file from earlier available, or are having trouble, you can <a class="reference download internal" download="" href="../_downloads/26f133d9caf2ef72e73893756d498eaf/ntuple_options.py"><code class="xref download docutils literal notranslate"><span class="pre">use</span> <span class="pre">this</span> <span class="pre">options</span> <span class="pre">file</span></code></a>.</p>
<p>The next file needed is a <code class="docutils literal notranslate"><span class="pre">.yaml</span></code> file, which will be used to configure the jobs. Create a new file named <code class="docutils literal notranslate"><span class="pre">info.yaml</span></code>, and add the following to it:</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">defaults</span><span class="p">:</span>
<span class="w"> </span><span class="nt">application</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">DaVinci/v46r4</span>
<span class="w"> </span><span class="nt">application</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">DaVinci/v46r10</span>
<span class="w"> </span><span class="nt">wg</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Charm</span>
<span class="w"> </span><span class="nt">automatically_configure</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">yes</span>
<span class="w"> </span><span class="nt">turbo</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">no</span>
Expand All @@ -350,7 +352,7 @@ <h2>Creating your own production<a class="headerlink" href="#creating-your-own-p
</div>
<p>Here, the unindented lines are the names of jobs (although <code class="docutils literal notranslate"><span class="pre">defaults</span></code> has a special function), and the indented lines are the options we’re applying to those jobs. Using this file will create one job called <code class="docutils literal notranslate"><span class="pre">2016_MagDown_PromptMC_D02KK</span></code>, that will read in data from the provided bookkeeping path. All the options applied under <code class="docutils literal notranslate"><span class="pre">defaults</span></code> are automatically applied to all other jobs - very useful for avoiding repetition. The options we’re using here are:</p>
<ul class="simple">
<li><p><strong>application</strong>: the version of DaVinci to use. Here we choose v46r4, the latest for Run 2 at the time of writing (see <a class="reference external" href="http://lhcbdoc.web.cern.ch/lhcbdoc/davinci/">here</a> to check what versions are available).</p></li>
<li><p><strong>application</strong>: the version of DaVinci to use. Here we choose v46r10, the latest for Run 2 at the time of writing (see <a class="reference external" href="http://lhcbdoc.web.cern.ch/lhcbdoc/davinci/">here</a> to check what versions are available).</p></li>
<li><p><strong>wg</strong>: the working group this production is a part of. Since this is a <span class="math notranslate nohighlight">\(` D^{0} \to K^{-}K^{+} `\)</span> decay, we’ll set this to <code class="docutils literal notranslate"><span class="pre">Charm</span></code>.</p></li>
<li><p><strong>inform</strong>: optionally, you can enter your email address to receive updates on the status of your jobs.</p></li>
<li><p><strong>automatically_configure</strong>: setting this to <code class="docutils literal notranslate"><span class="pre">yes</span></code> is what allowed us to remove all of those configuration lines from the options file. This is very useful when creating productions that use multiple years, or both data and MC.</p></li>
Expand Down Expand Up @@ -453,7 +455,7 @@ <h3>Creating a merge request<a class="headerlink" href="#creating-a-merge-reques
</section>
<section id="checks">
<h3>Checks<a class="headerlink" href="#checks" title="Permalink to this heading"></a></h3>
<p>For the start of Run 3 it was requested to add the <code class="docutils literal notranslate"><span class="pre">Checks</span></code> feature to AnalysisProductions. This facilitates offline monitoring by allowing automated simple analysis of tupling output to assist with data quality and early measurements. For now let’s stick with some simple ones but for full details you can <a class="reference external" href="https://lhcb-ap.docs.cern.ch/user_guide/creating.html#checks">check the documentation</a>.</p>
<p>For the start of Run 3 it was requested to add the <code class="docutils literal notranslate"><span class="pre">Checks</span></code> feature to AnalysisProductions. This facilitates offline monitoring by allowing automated simple analysis of tupling output to assist with data quality and early measurements. In the output of the CI you may have noticed some Checks already ran. These are default checks run for all productions to perform some basic validation of the production but you can also add your own. For now let’s stick with some simple ones but for full details you can <a class="reference external" href="https://lhcb-ap.docs.cern.ch/user_guide/creating.html#checks">check the documentation</a>.</p>
<p>We start by defining the checks we would like to perform. Add the following to your <code class="docutils literal notranslate"><span class="pre">info.yaml</span></code> below the <code class="docutils literal notranslate"><span class="pre">defaults</span></code>:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">checks</span><span class="p">:</span>
<span class="n">histogram</span><span class="p">:</span>
Expand Down Expand Up @@ -500,6 +502,14 @@ <h3>Checks<a class="headerlink" href="#checks" title="Permalink to this heading"
</div>
<div class="panel panel-callout docutils container">
<div class="panel-header open docutils container">
<p id="what-about-run-3"><i class="fa fa-info-circle"></i> What about Run 3</p>
</div>
<div class="panel-body docutils container">
<p>By and large the procedure for Run 3 is the same, the major differences are within the DaVinci scripts themselves so are covered by the DaVinci lessons. There are some additional configuration options required (at the time of writing) in the YAML file but your WG liaisons should be able to point you to examples.</p>
</div>
</div>
<div class="panel panel-callout docutils container">
<div class="panel-header open docutils container">
<p id="next-steps-for-real-productions"><i class="fa fa-info-circle"></i> Next steps for real productions</p>
</div>
<div class="panel-body docutils container">
Expand Down
14 changes: 8 additions & 6 deletions first-analysis-steps/analysisflow.html
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html5" lang="en">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>The analysis flow and analysis preservation &mdash; LHCb Starterkit Lessons documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/panels.css" type="text/css" />
<link rel="stylesheet" href="../_static/starterkit.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />
<link rel="stylesheet" type="text/css" href="../_static/panels.css" />
<link rel="stylesheet" type="text/css" href="../_static/starterkit.css" />


<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
Expand Down
Loading

0 comments on commit 67334f1

Please sign in to comment.