The purpose of this page is to provide some information about what the enclone installation command does, in case you're curious.
The command is:
curl -sSf -L bit.ly/enclone_install | bash -s SIZE
where SIZE is
small, medium or large
1. First, bit.ly/enclone_install is a redirect to
https://10xgenomics.github.io/enclone/install.sh, as you can see if you type
bit.ly/enclone_install+ (the + is the way that bit.ly
provides for seeing what a redirect does).
2. The -sSf option to curl 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 sh.
3. The overall command just causes the script install.sh to be executed.
4. On a first invocation, the script downloads the enclone executable and datasets.
5. 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
SIZE is medium, the action is
also inefficient, as it downloads everything if anything has changed.
6. The script puts the executable in ~/bin and the datasets in
~/enclone. These directories are created if they don't already exist.
7. The following step makes it so you don't have to type
~/bin/enclone every time you want to run it, and can instead type just
enclone. To enable this,
if ~/bin is not in your path, the script adds a line to
.bash_profile or .profile that makes ~/bin 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.
Questions? You can email us at enclone@10xgenomics.com.