-
Notifications
You must be signed in to change notification settings - Fork 14
/
Copy pathinstallation_details.html
88 lines (66 loc) · 3.7 KB
/
installation_details.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
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"https://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<!-- -->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="application/xml+xhtml; charset=UTF-8"/>
<title>enclone installation details</title>
<link rel="stylesheet" type="text/css" href="../enclone_css_v2.css">
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-58278925-3"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){{dataLayer.push(arguments);}}
gtag('js', new Date());
gtag('config', 'UA-58278925-3');
</script>
</head>
<! ––
💩 💩 💩 🔴 🔨 🔨 🔨 🔨 🔨 🔨 🔴 💩 💩 💩
PUT DOWN YOUR HAMMER.
THIS IS AN AUTO-GENERATED FILE. PLEASE DO NOT EDIT IT.
THANK YOU FOR YOUR COOPERATION,
SINCERELY,
THE BENEVOLENT OVERLORDS
💩 💩 💩 🔴 🔨 🔨 🔨 🔨 🔨 🔨 🔴 💩 💩 💩
––>
<body>
<br>
<a href="../../index.html#help">
<img src="../../img/enclone_banner.png" alt="enclone banner" title="enclone banner" width=100% />
</a>
<h1><span style="color:rgb(120,123,175);font-weight:900">enclone</span> installation details</h1>
<p>The purpose of this page is to provide some information about what the <span style="color:rgb(120,123,175);font-weight:900">enclone</span> installation
command does, in case you're curious.</p>
<p>The command is:</p>
<p>
<code>curl -sSf -L bit.ly/enclone_install | bash -s <span style="color:red; font-weight: bold">SIZE</span></code></pre>
where <code style="color:red; font-weight: bold">SIZE</code> is
<code>small</code>, <code>medium</code> or <code>large</code>
</p>
<p><b>1.</b> First, <code>bit.ly/enclone_install</code> is a redirect to
<code>https://10xgenomics.github.io/enclone/install.sh</code>, as you can see if you type
<code>bit.ly/enclone_install+</code> (the <code>+</code> is the way that <code>bit.ly</code>
provides for seeing what a redirect does).</p>
<p><b>2.</b> The <code>-sSf</code> option to <code>curl</code> causes it to run quietly if it
is successful, print an error message if it fails, and importantly, not pass logging or error
messages to <code>sh</code>.</p>
<p><b>3.</b> The overall command just causes the script <code>install.sh</code> to be executed.</p>
<p><b>4.</b> On a first invocation, the script downloads the <span style="color:rgb(120,123,175);font-weight:900">enclone</span> executable and datasets.</p>
<p><b>5.</b> On subsequent invocations, the script checks to see if the local copies are current,
and if not, redownloads them. In principle, the executable could be downloaded as a compressed
file, which would be more efficient. For the case where
<code style="color:red; font-weight: bold">SIZE</code> is <code>medium</code>, the action is
also inefficient, as it downloads everything if anything has changed.</p>
<p><b>6.</b> The script puts the executable in <code>~/bin</code> and the datasets in
<code>~/enclone</code>. These directories are created if they don't already exist.</p>
<p><b>7.</b> The following step makes it so you don't have to type
<code>~/bin/enclone</code> every time you want to run it, and can instead type just
<code>enclone</code>. To enable this,
if <code>~/bin</code> is not in your path, the script adds a line to
<code>.bash_profile</code> or <code>.profile</code> that makes <code>~/bin</code> first in
your path. (Which file is used depends on the version of Linux that you're using.) If you
want, when the script is done, you can manually tidy up the file to make it more readable.</p>
</body>
</html>