-
Notifications
You must be signed in to change notification settings - Fork 1
/
faq.html
263 lines (243 loc) · 19 KB
/
faq.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Frequently Asked Questions — EOS 1.0.13 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/contentui.css" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=67e44365" />
<link rel="canonical" href="https://eos.github.io/doc/faq.html" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=0086fcda"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/contentui.js"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@jupyter-widgets/html-manager@^1.0.1/dist/embed-amd.js"></script>
<script>window.MathJax = {"tex": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true}, "options": {"ignoreHtmlClass": "tex2jax_ignore|mathjax_ignore|document", "processHtmlClass": "tex2jax_process|mathjax_process|math|output_area"}}</script>
<script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Reference" href="reference/index.html" />
<link rel="prev" title="Common Tasks in Phenomenological Analyses" href="user-guide/tasks.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
EOS
<img src="_static/github-eos-logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-guide/index.html">User Guide</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Frequently Asked Questions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#how-do-i">How Do I …</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#use-eos-within-a-virtual-python-environment">… use EOS within a virtual Python environment?</a></li>
<li class="toctree-l3"><a class="reference internal" href="#use-eos-remotely">… use EOS remotely?</a></li>
<li class="toctree-l3"><a class="reference internal" href="#use-and-develop-eos-on-windows">… use and develop EOS on Windows?</a></li>
<li class="toctree-l3"><a class="reference internal" href="#check-the-installation">… check the installation?</a></li>
<li class="toctree-l3"><a class="reference internal" href="#choose-which-tag-to-use-for-b-to-s-ell-ell-observables">… choose which <code class="docutils literal notranslate"><span class="pre">tag</span></code> to use for <span class="math notranslate nohighlight">\(b \to s \ell \ell\)</span> observables</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="reference/index.html">Reference</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">EOS</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Frequently Asked Questions</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="frequently-asked-questions">
<h1>Frequently Asked Questions<a class="headerlink" href="#frequently-asked-questions" title="Link to this heading"></a></h1>
<p>This is a list of Frequently Asked Questions about EOS. Feel free to suggest new entries!</p>
<section id="how-do-i">
<h2>How Do I …<a class="headerlink" href="#how-do-i" title="Link to this heading"></a></h2>
<section id="use-eos-within-a-virtual-python-environment">
<span id="faq-virtualenv"></span><h3>… use EOS within a virtual Python environment?<a class="headerlink" href="#use-eos-within-a-virtual-python-environment" title="Link to this heading"></a></h3>
<p>We highly recommend to use EOS within a <strong>virtual Python environment</strong>. To do so, you
need to install the <code class="docutils literal notranslate"><span class="pre">virtualenv</span></code> package, and then create a new virtual environment:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip3</span> <span class="n">install</span> <span class="n">virtualenv</span>
<span class="n">virtualenv</span> <span class="o">--</span><span class="n">python</span><span class="o">=</span><span class="n">python3</span> <span class="o">~/</span><span class="n">eos</span>
</pre></div>
</div>
<p>The new virtual environment will now be <strong>activated</strong>.
That means, the <code class="docutils literal notranslate"><span class="pre">python</span></code> (and <code class="docutils literal notranslate"><span class="pre">pip</span></code>) command will now execute the local binary instead of a system-wide one.
At any later point, you can (re-)activate the virtual environment by running the following command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">source</span> <span class="o">~/</span><span class="n">eos</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">activate</span>
</pre></div>
</div>
<p>While activated, you can <strong>install</strong> a binary distribution of EOS using <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">eoshep</span></code>.
If you plan to install EOS from source, as discussed in the <a class="reference internal" href="installation.html#installation-from-source"><span class="std std-ref">installation section</span></a>, you must set the prefix
to match the path to your virtual environment, here: <code class="docutils literal notranslate"><span class="pre">~/eos</span></code>.</p>
<p>You most likely want to install <strong>jupyter and notebook</strong>.
To be able to access the virtual environment from the notebook interface, you also need to <em>install it</em> (details <a class="reference external" href="https://ipython.readthedocs.io/en/stable/install/kernel_install.html#kernels-for-different-environments">here</a>).
While activated, execute the following:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">jupyter</span> <span class="n">notebook</span>
<span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">ipykernel</span> <span class="n">install</span> <span class="o">--</span><span class="n">user</span> <span class="o">--</span><span class="n">name</span> <span class="n">venv</span><span class="o">-</span><span class="n">eos</span> <span class="o">--</span><span class="n">display</span><span class="o">-</span><span class="n">name</span> <span class="s2">"python3 with EOS"</span>
</pre></div>
</div>
<p>You can now <strong>use jupyter</strong> with <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">jupyter</span> <span class="pre">notebook</span></code> and choose <em>python3 with EOS</em> as a kernel.</p>
<p>To <strong>deactivate</strong> the virtual environment, run</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">deactivate</span>
</pre></div>
</div>
<p>Of course, you can choose a <strong>different directory</strong> than <code class="docutils literal notranslate"><span class="pre">~/eos</span></code> to host your virtual environment. Please see
the <code class="docutils literal notranslate"><span class="pre">virtualenv</span></code> <a class="reference external" href="https://virtualenv.pypa.io/en/latest/">documentation</a> for more information.</p>
</section>
<section id="use-eos-remotely">
<h3>… use EOS remotely?<a class="headerlink" href="#use-eos-remotely" title="Link to this heading"></a></h3>
<p>Since EOS can be used from within a Jupyter notebook, you can use it on a remote Linux computer.
We assume that remote computer has the hostname <code class="docutils literal notranslate"><span class="pre">`REMOTE_HOST`</span></code>. We further assume that you
can connect to that computer through a secure shell, via <code class="docutils literal notranslate"><span class="pre">`ssh</span> <span class="pre">REMOTE_HOST`</span></code> or some similar
command. Last but not least, we assume that you have installed EOS on the remote computer, e.g.
via the Python Package Index (PyPI): <code class="docutils literal notranslate"><span class="pre">`pip3</span> <span class="pre">install</span> <span class="pre">eoshep`</span></code>.
To use EOS on the remote computer through your local computer’s browser, you need to slightly
change your connection details.
Use <code class="docutils literal notranslate"><span class="pre">`ssh</span> <span class="pre">-L</span> <span class="pre">8888:localhost:8888</span> <span class="pre">REMOTE_HOST`</span></code> to connect. Now you can run <code class="docutils literal notranslate"><span class="pre">`jupyter-notebook</span> <span class="pre">--no-browser`</span></code>,
which will provide you with some output that looks as follows</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>To access the notebook, open this file in a browser:
...
Or copy and paste one of these URLs:
http://localhost:8888/?token=...
or http://127.0.0.1:8888/?token=...
</pre></div>
</div>
<p>Copy one of these links, making sure to include the lengthy token, and navigate to it in the
web browser on your local computer. You will be able to use EOS within an interactive Python environment.</p>
<p>You can make this more persistent by configuring your SSH connection to <code class="docutils literal notranslate"><span class="pre">`REMOTE_HOST`</span></code>. Please see the documentation
of your local computer’s secure shell program.</p>
</section>
<section id="use-and-develop-eos-on-windows">
<h3>… use and develop EOS on Windows?<a class="headerlink" href="#use-and-develop-eos-on-windows" title="Link to this heading"></a></h3>
<p>EOS can be used on Windows through the Windows Subsystem for Linux (WSL),
which is offered and developed by Microsoft themselves.
The installation of WSL is described in detail <a class="reference external" href="https://docs.microsoft.com/en-us/windows/wsl/install">here</a>.
The installation provides you with a Linux container in a virtual machine.
From here on, you can follow the instructions for the installation method of your choosing described for EOS under Linux.
If you would like to make adaptions to the code for a project using EOS and/or contribute to its development,
we recommend using the Visual Studio Code editor as your development environment.
It supports connecting natively to the WSL container if you follow these <a class="reference external" href="https://code.visualstudio.com/docs/remote/wsl">steps</a>.</p>
</section>
<section id="check-the-installation">
<span id="faq-check-installation"></span><h3>… check the installation?<a class="headerlink" href="#check-the-installation" title="Link to this heading"></a></h3>
<p>You can test with a single command that EOS is available as a python module:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python3<span class="w"> </span>-c<span class="w"> </span><span class="s2">"import eos; print(eos.__doc__)"</span>
</pre></div>
</div>
<p>Please verify that the command prints a description of the EOS module:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>EOS is a software package that addresses several use cases in the field of high-energy flavor physics (HEP). [...]
</pre></div>
</div>
<p>If you built and installed from the source code
and the import fails, i.e. you see <code class="docutils literal notranslate"><span class="pre">ModuleNotFoundError:</span> <span class="pre">No</span> <span class="pre">module</span> <span class="pre">named</span> <span class="pre">'eos'</span></code>,
the module was either not installed with <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">install</span></code> or the <code class="docutils literal notranslate"><span class="pre">PYTHONPATH</span></code> is not configured correctly.</p>
<p>If you installed via <code class="docutils literal notranslate"><span class="pre">pip</span></code>
and the output description is incorrect or <code class="docutils literal notranslate"><span class="pre">None</span></code>,
you have another module installed that is also named <code class="docutils literal notranslate"><span class="pre">eos</span></code>.
Mind that the package name for the <code class="docutils literal notranslate"><span class="pre">pip3</span> <span class="pre">install</span></code> command is <code class="docutils literal notranslate"><span class="pre">eoshep</span></code>.</p>
</section>
<section id="choose-which-tag-to-use-for-b-to-s-ell-ell-observables">
<span id="faq-tags"></span><h3>… choose which <code class="docutils literal notranslate"><span class="pre">tag</span></code> to use for <span class="math notranslate nohighlight">\(b \to s \ell \ell\)</span> observables<a class="headerlink" href="#choose-which-tag-to-use-for-b-to-s-ell-ell-observables" title="Link to this heading"></a></h3>
<p>The contributions from non-local operators in <span class="math notranslate nohighlight">\(b \to s \ell \ell\)</span> observables
can be estimated with different theoretical approaches, usually not valid in the same energy range,
based on different input parameters and different theoretical assumptions.
Depending on the analysis under consideration, the user can choose between these approaches by specifying an option called <code class="docutils literal notranslate"><span class="pre">tag</span></code>.
As different <code class="docutils literal notranslate"><span class="pre">tags</span></code> hide completely different assumptions, we have made this option mandatory.</p>
<p>We collect here the different <code class="docutils literal notranslate"><span class="pre">tags</span></code> used in EOS and the corresponding references.</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 15.0%" />
<col style="width: 55.0%" />
<col style="width: 30.0%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p><code class="docutils literal notranslate"><span class="pre">tag</span></code></p></th>
<th class="head"><p>Description</p></th>
<th class="head"><p>Reference</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">Naive</span></code></p></td>
<td><p>Absence of any non-local contributions.</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">BFS2004</span></code></p></td>
<td><p>Calculation of the non-local contribution based on the framework of QCD factorization
and a perturbative treatment of the intermediate quark states.
This approach is expected to yield sensible results only for <span class="math notranslate nohighlight">\(q^2 \ll 4 m_c^2\)</span>.</p></td>
<td><p>[BFS:2001A], [BFS:2004A]</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">GP2004</span></code></p></td>
<td><p>Calculation of the non-local contributions in a local OPE. This approach is expected
to yield sensible results only for <span class="math notranslate nohighlight">\(q^2\)</span>-integrated observables above the open-charm threshold.</p></td>
<td><p>[GP:2004A]</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">GvDV2020</span></code></p></td>
<td><p>Parametrization based on unitarity and analyticity valid for small dilepton masses below the <span class="math notranslate nohighlight">\(\psi(2S)\)</span> state.</p></td>
<td><p>[GvDV:2020A], [GRvDV:2022A]</p></td>
</tr>
</tbody>
</table>
</section>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="user-guide/tasks.html" class="btn btn-neutral float-left" title="Common Tasks in Phenomenological Analyses" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="reference/index.html" class="btn btn-neutral float-right" title="Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2019-2024, The EOS Authors.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>