Skip to content

P
PRESCOTT
Commit ad6a987f by Mustafa Tekpinar
Options

Updated the documentation for v1.6.0!

parent dca69ed1
Showing with 208 additions and 102 deletions
Dockerfile
......@@ -98,21 +98,21 @@ RUN pip3 install https://github.com/debbiemarkslab/EVcouplings/archive/develop.z
# If run command on M1 Mac with macOS Monterey, you can remove sudo
# Build command
# sudo docker build -t tekpinar/prescott-docker:v1.5.1 .
# sudo docker build -t tekpinar/prescott-docker:v1.6.0 .
# sudo docker login
# sudo docker push tekpinar/prescott-docker:v1.5.1
# sudo docker push tekpinar/prescott-docker:v1.6.0
# Pull command on M1 Mac with macOS Monterey
# sudo docker pull tekpinar/prescott-docker:v1.5.1
# sudo docker pull tekpinar/prescott-docker:v1.6.0
# Run commands
# sudo docker run -i -t -v $(pwd) --platform linux/amd64 tekpinar/prescott-docker:v1.5.1 /bin/bash
# sudo docker run -i -t -v $(pwd) --platform linux/amd64 tekpinar/prescott-docker:v1.6.0 /bin/bash
# Bind your current folder to a particular folder in docker.
# In this way, you fall into the bash terminal of the docker image.
# docker run -ti --rm --mount type=bind,source=$PWD,target=/home/tekpinar/research/lcqb tekpinar/prescott-docker:v1.5.1
# docker run -ti --rm --mount type=bind,source=$PWD,target=/home/tekpinar/research/lcqb tekpinar/prescott-docker:v1.6.0
#If you want to use the docker image like an executable file:
# Please note that you must have aliBLAT.fasta and blat-af2.pdb inside your current folder and run this command!
# sudo docker run --rm -v $PWD:/home/tekpinar/research/lcqb tekpinar/prescott-docker:v1.5.1 escott aliBLAT.fasta --pdbfile blat-af2.pdb
# sudo docker run --rm -v $PWD:/home/tekpinar/research/lcqb tekpinar/prescott-docker:v1.6.0 escott aliBLAT.fasta --pdbfile blat-af2.pdb
Singularityfile.sh deleted 100644 → 0
#!/bin/bash
#You can not run docker on many high performance computing systems
#due to sudo permissions etc.
#However, singularity can be run on them. Due to this reason, I prepared
#this file to show how you can prepare a singulartiy sif file from docker
#image of PRESCOTT.
#STEP 0: First thing first! You must have singularity installed on your system.
# If not, you can find the installation instructions here:
# https://github.com/sylabs/singularity/blob/main/INSTALL.md
# In addition, there are different releases(deb, rpm or source) in the following page:
# https://github.com/sylabs/singularity/releases
#STEP 1: Building singularity from the docker image online:
# Please note that you will need to change (v1.5.1) to the version you want
# if there is an update in the version.
singularity build prescott-docker-v1.5.1.sif docker://tekpinar/prescott-docker:v1.5.1
#STEP 2: Running escott with the sif file:
singularity exec prescott-docker-v1.5.1.sif escott -h
#STEP 3: Running prescott with the sif file:
singularity exec prescott-docker-v1.5.1.sif prescott -h
#STEP 4: Go to the folder where both aliBLAT.fasta and blat-af2.pdb are located.
# These two files are provided in the data folder of this repository.
# YOUR_SINGULARITY_DIR is where prescott-docker-v1.5.1.sif file located.
singularity exec --home `pwd` $YOUR_SINGULARITY_DIR/prescott-docker-v1.5.1.sif escott aliBLAT.fasta --pdbfile blat-af2.pdb
docs/_build/html/.buildinfo
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 5c84254d67e9b464e3ef5db2238ded56
config: c08592d911c59bb40f4fc837e9874171
tags: 645f666f9bcd5a90fca523b33c5a78b7
docs/_build/html/_sources/index.rst.txt
......@@ -14,6 +14,7 @@ Welcome to PRESCOTT documentation!
docker.rst
analysis.rst
input-preparation.rst
singularity.rst
installation.rst
Indices and tables
......
docs/_build/html/_sources/installation.rst.txt
......@@ -41,7 +41,7 @@ Then, source the saved .profile so that the environment variable will be taken i
JET2 is essential and it should be installed to be able to use PRESCOTT.
Preparation of the environment and installation of PRESCOTT
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Step by step installation on Ubuntu 22.04
......
docs/_build/html/_static/documentation_options.js
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '1.5.0',
VERSION: '1.6.0',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
......
docs/_build/html/analysis.html
......@@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Analyzing and Modifying the ESCOTT Output &mdash; prescott 1.5.0 documentation</title>
<title>Analyzing and Modifying the ESCOTT Output &mdash; prescott 1.6.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
......
docs/_build/html/docker.html
......@@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Using ESCOTT via Docker &mdash; prescott 1.5.0 documentation</title>
<title>Using ESCOTT via Docker &mdash; prescott 1.6.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
......
docs/_build/html/genindex.html
......@@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &mdash; prescott 1.5.0 documentation</title>
<title>Index &mdash; prescott 1.6.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
......@@ -45,6 +45,7 @@
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using ESCOTT via Docker</a></li>
<li class="toctree-l1"><a class="reference internal" href="analysis.html">Analyzing and Modifying the ESCOTT Output</a></li>
<li class="toctree-l1"><a class="reference internal" href="input-preparation.html">Preparing Your Own Input</a></li>
<li class="toctree-l1"><a class="reference internal" href="singularity.html">Using ESCOTT via Singularity</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
</ul>
......
docs/_build/html/index.html
......@@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Welcome to PRESCOTT documentation! &mdash; prescott 1.5.0 documentation</title>
<title>Welcome to PRESCOTT documentation! &mdash; prescott 1.6.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
......@@ -47,6 +47,7 @@
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using ESCOTT via Docker</a></li>
<li class="toctree-l1"><a class="reference internal" href="analysis.html">Analyzing and Modifying the ESCOTT Output</a></li>
<li class="toctree-l1"><a class="reference internal" href="input-preparation.html">Preparing Your Own Input</a></li>
<li class="toctree-l1"><a class="reference internal" href="singularity.html">Using ESCOTT via Singularity</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
</ul>
......@@ -105,6 +106,7 @@
<li class="toctree-l2"><a class="reference internal" href="input-preparation.html#preparing-your-input-msa-and-pdb-with-colabfold">Preparing Your Input MSA and PDB with Colabfold</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="singularity.html">Using ESCOTT via Singularity</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installing-the-dependencies">Installing the dependencies:</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#preparation-of-the-environment-and-installation-of-prescott">Preparation of the environment and installation of PRESCOTT</a></li>
......
docs/_build/html/input-preparation.html
......@@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Preparing Your Own Input &mdash; prescott 1.5.0 documentation</title>
<title>Preparing Your Own Input &mdash; prescott 1.6.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
......
docs/_build/html/installation.html
......@@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Installation &mdash; prescott 1.5.0 documentation</title>
<title>Installation &mdash; prescott 1.6.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
......@@ -43,8 +43,9 @@
</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="docker.html">Using PRESCOTT via Docker</a></li>
<li class="toctree-l1"><a class="reference internal" href="analysis.html">Analyzing and Modifying the PRESCOTT Output</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using ESCOTT via Docker</a></li>
<li class="toctree-l1"><a class="reference internal" href="analysis.html">Analyzing and Modifying the ESCOTT Output</a></li>
<li class="toctree-l1"><a class="reference internal" href="input-preparation.html">Preparing Your Own Input</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#installing-the-dependencies">Installing the dependencies:</a></li>
......
docs/_build/html/introduction.html
......@@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Introduction &mdash; prescott 1.5.0 documentation</title>
<title>Introduction &mdash; prescott 1.6.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
......
docs/_build/html/search.html
......@@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Search &mdash; prescott 1.5.0 documentation</title>
<title>Search &mdash; prescott 1.6.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
......@@ -48,6 +48,7 @@
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using ESCOTT via Docker</a></li>
<li class="toctree-l1"><a class="reference internal" href="analysis.html">Analyzing and Modifying the ESCOTT Output</a></li>
<li class="toctree-l1"><a class="reference internal" href="input-preparation.html">Preparing Your Own Input</a></li>
<li class="toctree-l1"><a class="reference internal" href="singularity.html">Using ESCOTT via Singularity</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
</ul>
......
docs/_build/latex/prescott.aux
......@@ -80,19 +80,24 @@
\newlabel{input-preparation::doc}{{4}{11}{Preparing Your Own Input}{chapter.4}{}}
\@writefile{toc}{\contentsline {section}{\numberline {4.1}Preparing Your Input MSA and PDB with Colabfold}{11}{section.4.1}\protected@file@percent }
\newlabel{input-preparation:preparing-your-input-msa-and-pdb-with-colabfold}{{4.1}{11}{Preparing Your Input MSA and PDB with Colabfold}{section.4.1}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {5}Installation}{13}{chapter.5}\protected@file@percent }
\@writefile{toc}{\contentsline {chapter}{\numberline {5}Using ESCOTT via Singularity}{13}{chapter.5}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\newlabel{installation:installation}{{5}{13}{Installation}{chapter.5}{}}
\newlabel{installation::doc}{{5}{13}{Installation}{chapter.5}{}}
\@writefile{toc}{\contentsline {section}{\numberline {5.1}Installing the dependencies:}{13}{section.5.1}\protected@file@percent }
\newlabel{installation:installing-the-dependencies}{{5.1}{13}{Installing the dependencies:}{section.5.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {5.2}Preparation of the environment and installation of PRESCOTT}{13}{section.5.2}\protected@file@percent }
\newlabel{installation:preparation-of-the-environment-and-installation-of-prescott}{{5.2}{13}{Preparation of the environment and installation of PRESCOTT}{section.5.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {5.3}Configuring default.conf file}{15}{section.5.3}\protected@file@percent }
\newlabel{installation:configuring-default-conf-file}{{5.3}{15}{Configuring default.conf file}{section.5.3}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {6}Indices and tables}{17}{chapter.6}\protected@file@percent }
\newlabel{singularity:using-escott-via-singularity}{{5}{13}{Using ESCOTT via Singularity}{chapter.5}{}}
\newlabel{singularity::doc}{{5}{13}{Using ESCOTT via Singularity}{chapter.5}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {6}Installation}{15}{chapter.6}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\newlabel{index:indices-and-tables}{{6}{17}{Indices and tables}{chapter.6}{}}
\gdef \@abspage@last{21}
\newlabel{installation:installation}{{6}{15}{Installation}{chapter.6}{}}
\newlabel{installation::doc}{{6}{15}{Installation}{chapter.6}{}}
\@writefile{toc}{\contentsline {section}{\numberline {6.1}Installing the dependencies:}{15}{section.6.1}\protected@file@percent }
\newlabel{installation:installing-the-dependencies}{{6.1}{15}{Installing the dependencies:}{section.6.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {6.2}Preparation of the environment and installation of PRESCOTT}{15}{section.6.2}\protected@file@percent }
\newlabel{installation:preparation-of-the-environment-and-installation-of-prescott}{{6.2}{15}{Preparation of the environment and installation of PRESCOTT}{section.6.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {6.3}Configuring default.conf file}{17}{section.6.3}\protected@file@percent }
\newlabel{installation:configuring-default-conf-file}{{6.3}{17}{Configuring default.conf file}{section.6.3}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {7}Indices and tables}{19}{chapter.7}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\newlabel{index:indices-and-tables}{{7}{19}{Indices and tables}{chapter.7}{}}
\gdef \@abspage@last{23}
docs/_build/latex/prescott.fdb_latexmk
# Fdb version 3
["makeindex prescott.idx"] 1691770116 "prescott.idx" "prescott.ind" "prescott" 1700227059
"prescott.idx" 1700227058 0 d41d8cd98f00b204e9800998ecf8427e "pdflatex"
["makeindex prescott.idx"] 1691770116 "prescott.idx" "prescott.ind" "prescott" 1701352785
"prescott.idx" 1701352785 0 d41d8cd98f00b204e9800998ecf8427e "pdflatex"
(generated)
"prescott.ilg"
"prescott.ind"
["pdflatex"] 1700227058 "prescott.tex" "prescott.pdf" "prescott" 1700227059
["pdflatex"] 1701352784 "prescott.tex" "prescott.pdf" "prescott" 1701352785
"/etc/texmf/web2c/texmf.cnf" 1686915816 475 c0e671620eb5563b2130f56340a5fde8 ""
"/usr/share/texlive/texmf-dist/fonts/map/fontname/texfonts.map" 1577235249 3524 cb3e574dea2d1052e39280babc910dc8 ""
"/usr/share/texlive/texmf-dist/fonts/tfm/jknappen/ec/ecrm1000.tfm" 1136768653 3584 adb004a0c8e7c46ee66cad73671f37b4 ""
......@@ -140,13 +140,13 @@
"/usr/share/texmf/web2c/texmf.cnf" 1644012257 39432 7155514e09a3d69036fac785183a21c2 ""
"/var/lib/texmf/fonts/map/pdftex/updmap/pdftex.map" 1692610720 128028 f533b797fba58d231669ea19e894e23e ""
"/var/lib/texmf/web2c/pdftex/pdflatex.fmt" 1692610730 1455466 cf5d347cc06e6f91065ccb2619b82e95 ""
"prescott.aux" 1700227058 8757 49bd9be15e4a1990a75c401ccac48f11 "pdflatex"
"prescott.aux" 1701352785 9143 aed8bca5ac12c0ebd50681d413e58d41 "pdflatex"
"prescott.ind" 1694694190 0 d41d8cd98f00b204e9800998ecf8427e "makeindex prescott.idx"
"prescott.out" 1700227058 6307 8119393c8f110ffbb217a1e7b2c390de "pdflatex"
"prescott.tex" 1700227058 33833 c5b13bae0058b8edd46789a6b12ea3ec ""
"prescott.toc" 1700227058 2706 6a2a8c488f73b27e9fedb6cddefdfa53 "pdflatex"
"prescott.out" 1701352785 6500 451b70ed444684f0bdee8ace15638a1b "pdflatex"
"prescott.tex" 1701352784 36391 7990fd9a7dcbf4423b4d9f0a3d541afe ""
"prescott.toc" 1701352785 2791 ec37ce19b28894e4de4791b16a96dddb "pdflatex"
"sphinx.sty" 1691571542 12780 919e6ba449302e2597e7722681a087c6 ""
"sphinxhighlight.sty" 1700227057 6679 76d10c62e0f0661410b46f5db6118e26 ""
"sphinxhighlight.sty" 1701352784 6679 76d10c62e0f0661410b46f5db6118e26 ""
"sphinxlatexadmonitions.sty" 1691571543 6238 2d867d769abf3f72abc17ef52adff78b ""
"sphinxlatexcontainers.sty" 1691571543 901 d3a3a1b7b2547f47ade2499350b5c420 ""
"sphinxlatexgraphics.sty" 1691571543 4840 a9578332b6f3b35e198751fb632c9b79 ""
......@@ -161,7 +161,7 @@
"sphinxlatexstyletext.sty" 1691571543 6177 c18841ce3fafc366cd3b145f8faa4c37 ""
"sphinxlatextables.sty" 1691571542 21848 2827eb0b11b99b185a8b77317d3e131c ""
"sphinxmanual.cls" 1691571543 4241 7b0d7a37df7b5715fb0dbd585c52ecdb ""
"sphinxmessages.sty" 1700227058 745 3f5fcd6cdd7964ed608767954a8ced6f ""
"sphinxmessages.sty" 1701352784 745 3f5fcd6cdd7964ed608767954a8ced6f ""
"sphinxoptionsgeometry.sty" 1691571542 2061 47bb34b8ed8a78823eb0c886abfb9f4d ""
"sphinxoptionshyperref.sty" 1691571543 1094 79beb8b8a3f10784f8cce804e0f9d3aa ""
"sphinxpackagefootnote.sty" 1691571543 15217 dd26fe418b6fb1b26b18f042a7f43d40 ""
......
docs/_build/latex/prescott.log
This is pdfTeX, Version 3.141592653-2.6-1.40.22 (TeX Live 2022/dev/Debian) (preloaded format=pdflatex 2023.8.21) 17 NOV 2023 14:17
This is pdfTeX, Version 3.141592653-2.6-1.40.22 (TeX Live 2022/dev/Debian) (preloaded format=pdflatex 2023.8.21) 30 NOV 2023 14:59
entering extended mode
restricted \write18 enabled.
%&-line parsing enabled.
......@@ -814,25 +814,29 @@ LaTeX Font Info: Font shape `T1/txtt/m/it' in size <10> not available
Chapter 5.
[13
] [14]
Underfull \hbox (badness 7981) in paragraph at lines 829--832
] [14
]
Chapter 6.
[15] [16]
Underfull \hbox (badness 7981) in paragraph at lines 904--907
[]\T1/qtm/m/n/10 #Down-load PRESCOTT from [][]$http : / / gitlab . lcqb . upmc
. fr / tekpinar / PRESCOTT$[][] repos-i-tory and go in-side the
[]
[15] [16
[17] [18
]
Chapter 6.
(./prescott.ind) [17] (./prescott.aux)
Chapter 7.
(./prescott.ind) [19] (./prescott.aux)
Package rerunfilecheck Info: File `prescott.out' has not changed.
(rerunfilecheck) Checksum: 8119393C8F110FFBB217A1E7B2C390DE;6307.
(rerunfilecheck) Checksum: 451B70ED444684F0BDEE8ACE15638A1B;6500.
)
Here is how much of TeX's memory you used:
14692 strings out of 480204
234053 string characters out of 5895010
598445 words of memory out of 5000000
32211 multiletter control sequences out of 15000+600000
14699 strings out of 480204
234164 string characters out of 5895010
598549 words of memory out of 5000000
32215 multiletter control sequences out of 15000+600000
520869 words of font info for 70 fonts, out of 8000000 for 9000
37 hyphenation exceptions out of 8191
70i,11n,76p,434b,568s stack positions out of 5000i,500n,10000p,200000b,80000s
......@@ -846,10 +850,10 @@ usr/share/texlive/texmf-dist/fonts/type1/public/txfonts/t1xbtt.pfb></usr/share/
texlive/texmf-dist/fonts/type1/public/txfonts/t1xtt.pfb></usr/share/texlive/tex
mf-dist/fonts/type1/public/txfonts/t1xtt.pfb></usr/share/texlive/texmf-dist/fon
ts/type1/public/txfonts/tcxtt.pfb>
Output written on prescott.pdf (21 pages, 173782 bytes).
Output written on prescott.pdf (23 pages, 177499 bytes).
PDF statistics:
332 PDF objects out of 1000 (max. 8388607)
289 compressed objects within 3 object streams
67 named destinations out of 1000 (max. 500000)
253 words of extra memory for PDF output out of 10000 (max. 10000000)
350 PDF objects out of 1000 (max. 8388607)
304 compressed objects within 4 object streams
70 named destinations out of 1000 (max. 500000)
261 words of extra memory for PDF output out of 10000 (max. 10000000)
docs/_build/latex/prescott.out
......@@ -22,8 +22,9 @@
\BOOKMARK [1][-]{section.3.3}{\376\377\000S\000e\000l\000e\000c\000t\000e\000d\000\040\000S\000i\000n\000g\000l\000e\000\040\000P\000o\000i\000n\000t\000\040\000o\000r\000\040\000M\000u\000l\000t\000i\000p\000l\000e\000\040\000P\000o\000i\000n\000t\000\040\000M\000u\000t\000a\000t\000i\000o\000n\000\040\000C\000a\000l\000c\000u\000l\000a\000t\000i\000o\000n\000s}{chapter.3}% 22
\BOOKMARK [0][-]{chapter.4}{\376\377\000P\000r\000e\000p\000a\000r\000i\000n\000g\000\040\000Y\000o\000u\000r\000\040\000O\000w\000n\000\040\000I\000n\000p\000u\000t}{}% 23
\BOOKMARK [1][-]{section.4.1}{\376\377\000P\000r\000e\000p\000a\000r\000i\000n\000g\000\040\000Y\000o\000u\000r\000\040\000I\000n\000p\000u\000t\000\040\000M\000S\000A\000\040\000a\000n\000d\000\040\000P\000D\000B\000\040\000w\000i\000t\000h\000\040\000C\000o\000l\000a\000b\000f\000o\000l\000d}{chapter.4}% 24
\BOOKMARK [0][-]{chapter.5}{\376\377\000I\000n\000s\000t\000a\000l\000l\000a\000t\000i\000o\000n}{}% 25
\BOOKMARK [1][-]{section.5.1}{\376\377\000I\000n\000s\000t\000a\000l\000l\000i\000n\000g\000\040\000t\000h\000e\000\040\000d\000e\000p\000e\000n\000d\000e\000n\000c\000i\000e\000s\000:}{chapter.5}% 26
\BOOKMARK [1][-]{section.5.2}{\376\377\000P\000r\000e\000p\000a\000r\000a\000t\000i\000o\000n\000\040\000o\000f\000\040\000t\000h\000e\000\040\000e\000n\000v\000i\000r\000o\000n\000m\000e\000n\000t\000\040\000a\000n\000d\000\040\000i\000n\000s\000t\000a\000l\000l\000a\000t\000i\000o\000n\000\040\000o\000f\000\040\000P\000R\000E\000S\000C\000O\000T\000T}{chapter.5}% 27
\BOOKMARK [1][-]{section.5.3}{\376\377\000C\000o\000n\000f\000i\000g\000u\000r\000i\000n\000g\000\040\000d\000e\000f\000a\000u\000l\000t\000.\000c\000o\000n\000f\000\040\000f\000i\000l\000e}{chapter.5}% 28
\BOOKMARK [0][-]{chapter.6}{\376\377\000I\000n\000d\000i\000c\000e\000s\000\040\000a\000n\000d\000\040\000t\000a\000b\000l\000e\000s}{}% 29
\BOOKMARK [0][-]{chapter.5}{\376\377\000U\000s\000i\000n\000g\000\040\000E\000S\000C\000O\000T\000T\000\040\000v\000i\000a\000\040\000S\000i\000n\000g\000u\000l\000a\000r\000i\000t\000y}{}% 25
\BOOKMARK [0][-]{chapter.6}{\376\377\000I\000n\000s\000t\000a\000l\000l\000a\000t\000i\000o\000n}{}% 26
\BOOKMARK [1][-]{section.6.1}{\376\377\000I\000n\000s\000t\000a\000l\000l\000i\000n\000g\000\040\000t\000h\000e\000\040\000d\000e\000p\000e\000n\000d\000e\000n\000c\000i\000e\000s\000:}{chapter.6}% 27
\BOOKMARK [1][-]{section.6.2}{\376\377\000P\000r\000e\000p\000a\000r\000a\000t\000i\000o\000n\000\040\000o\000f\000\040\000t\000h\000e\000\040\000e\000n\000v\000i\000r\000o\000n\000m\000e\000n\000t\000\040\000a\000n\000d\000\040\000i\000n\000s\000t\000a\000l\000l\000a\000t\000i\000o\000n\000\040\000o\000f\000\040\000P\000R\000E\000S\000C\000O\000T\000T}{chapter.6}% 28
\BOOKMARK [1][-]{section.6.3}{\376\377\000C\000o\000n\000f\000i\000g\000u\000r\000i\000n\000g\000\040\000d\000e\000f\000a\000u\000l\000t\000.\000c\000o\000n\000f\000\040\000f\000i\000l\000e}{chapter.6}% 29
\BOOKMARK [0][-]{chapter.7}{\376\377\000I\000n\000d\000i\000c\000e\000s\000\040\000a\000n\000d\000\040\000t\000a\000b\000l\000e\000s}{}% 30
docs/_build/latex/prescott.tex
......@@ -61,8 +61,8 @@
\title{prescott}
\date{Nov 17, 2023}
\release{1.5.0}
\date{Nov 30, 2023}
\release{1.6.0}
\author{Mustafa Tekpinar}
\newcommand{\sphinxlogo}{\vbox{}}
\renewcommand{\releasename}{Release}
......@@ -663,6 +663,81 @@ An input PDB: myprotein.pdb
\sphinxstepscope
\chapter{Using ESCOTT via Singularity}
\label{\detokenize{singularity:using-escott-via-singularity}}\label{\detokenize{singularity::doc}}
\sphinxAtStartPar
You can not run docker on many high performance computing systems
due to sudo permissions etc.
However, singularity can be run on them. Due to this reason, I prepared
this file to show how you can prepare a singulartiy sif file from (online) docker
image of PRESCOTT.
\begin{itemize}
\item {}
\sphinxAtStartPar
STEP 0: First thing first! You must have singularity installed on your system.
\begin{quote}
\sphinxAtStartPar
If not, you can find the installation instructions here:
\sphinxurl{https://github.com/sylabs/singularity/blob/main/INSTALL.md}
\sphinxAtStartPar
In addition, there are different releases(deb, rpm or source) in the following page:
\sphinxurl{https://github.com/sylabs/singularity/releases}
\end{quote}
\item {}
\sphinxAtStartPar
STEP 1: Building singularity from the docker image online:
\begin{quote}
\begin{sphinxVerbatim}[commandchars=\\\{\}]
singularity build prescott\PYGZhy{}docker\PYGZhy{}v1.6.0.sif docker://tekpinar/prescott\PYGZhy{}docker:v1.6.0
\end{sphinxVerbatim}
\sphinxAtStartPar
Please note that you will need to change (v1.6.0) to the version you want if there is an update in the version.
\end{quote}
\item {}
\sphinxAtStartPar
STEP 2: Running escott with the sif file:
\begin{quote}
\begin{sphinxVerbatim}[commandchars=\\\{\}]
singularity \PYG{n+nb}{exec} prescott\PYGZhy{}docker\PYGZhy{}v1.6.0.sif escott \PYGZhy{}h
\end{sphinxVerbatim}
\end{quote}
\item {}
\sphinxAtStartPar
STEP 3: Running prescott with the sif file:
\begin{quote}
\begin{sphinxVerbatim}[commandchars=\\\{\}]
singularity \PYG{n+nb}{exec} prescott\PYGZhy{}docker\PYGZhy{}v1.6.0.sif prescott \PYGZhy{}h
\end{sphinxVerbatim}
\end{quote}
\item {} \begin{description}
\sphinxlineitem{STEP 4: Go to the folder where both aliBLAT.fasta and blat\sphinxhyphen{}af2.pdb are located.}\begin{quote}
\sphinxAtStartPar
These two files are provided in the data folder of this repository.
YOUR\_SINGULARITY\_DIR is where prescott\sphinxhyphen{}docker\sphinxhyphen{}v1.6.0.sif file is located.
\end{quote}
\begin{sphinxVerbatim}[commandchars=\\\{\}]
singularity \PYG{n+nb}{exec} \PYGZhy{}\PYGZhy{}home \PYG{l+s+sb}{`}\PYG{n+nb}{pwd}\PYG{l+s+sb}{`} \PYG{n+nv}{\PYGZdl{}YOUR\PYGZus{}SINGULARITY\PYGZus{}DIR}/prescott\PYGZhy{}docker\PYGZhy{}v1.6.0.sif escott aliBLAT.fasta \PYGZhy{}\PYGZhy{}pdbfile blat\PYGZhy{}af2.pdb
\end{sphinxVerbatim}
\end{description}
\end{itemize}
\sphinxstepscope
\chapter{Installation}
\label{\detokenize{installation:installation}}\label{\detokenize{installation::doc}}
\sphinxAtStartPar
......
docs/_build/latex/prescott.toc
......@@ -23,8 +23,9 @@
\contentsline {section}{\numberline {3.3}Selected Single Point or Multiple Point Mutation Calculations}{10}{section.3.3}%
\contentsline {chapter}{\numberline {4}Preparing Your Own Input}{11}{chapter.4}%
\contentsline {section}{\numberline {4.1}Preparing Your Input MSA and PDB with Colabfold}{11}{section.4.1}%
\contentsline {chapter}{\numberline {5}Installation}{13}{chapter.5}%
\contentsline {section}{\numberline {5.1}Installing the dependencies:}{13}{section.5.1}%
\contentsline {section}{\numberline {5.2}Preparation of the environment and installation of PRESCOTT}{13}{section.5.2}%
\contentsline {section}{\numberline {5.3}Configuring default.conf file}{15}{section.5.3}%
\contentsline {chapter}{\numberline {6}Indices and tables}{17}{chapter.6}%
\contentsline {chapter}{\numberline {5}Using ESCOTT via Singularity}{13}{chapter.5}%
\contentsline {chapter}{\numberline {6}Installation}{15}{chapter.6}%
\contentsline {section}{\numberline {6.1}Installing the dependencies:}{15}{section.6.1}%
\contentsline {section}{\numberline {6.2}Preparation of the environment and installation of PRESCOTT}{15}{section.6.2}%
\contentsline {section}{\numberline {6.3}Configuring default.conf file}{17}{section.6.3}%
\contentsline {chapter}{\numberline {7}Indices and tables}{19}{chapter.7}%
docs/conf.py
......@@ -23,7 +23,7 @@ copyright = '2023, Mustafa Tekpinar'
author = 'Mustafa Tekpinar'
# The full version, including alpha/beta/rc tags
release = '1.5.1'
release = '1.6.0'
# -- General configuration ---------------------------------------------------
......
docs/index.rst
......@@ -14,6 +14,7 @@ Welcome to PRESCOTT documentation!
docker.rst
analysis.rst
input-preparation.rst
singularity.rst
installation.rst
Indices and tables
......
docs/installation.rst
......@@ -41,7 +41,7 @@ Then, source the saved .profile so that the environment variable will be taken i
JET2 is essential and it should be installed to be able to use PRESCOTT.
Preparation of the environment and installation of PRESCOTT
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Step by step installation on Ubuntu 22.04
......
docs/singularity.rst 0 → 100644
Using ESCOTT via Singularity
============================
You can not run docker on many high performance computing systems
due to sudo permissions etc.
However, singularity can be run on them. Due to this reason, I prepared
this file to show how you can prepare a singulartiy sif file from (online) docker
image of PRESCOTT.
* STEP 0: First thing first! You must have singularity installed on your system.
If not, you can find the installation instructions here:
https://github.com/sylabs/singularity/blob/main/INSTALL.md
In addition, there are different releases(deb, rpm or source) in the following page:
https://github.com/sylabs/singularity/releases
* STEP 1: Building singularity from the docker image online:
.. code:: bash
singularity build prescott-docker-v1.6.0.sif docker://tekpinar/prescott-docker:v1.6.0
Please note that you will need to change (v1.6.0) to the version you want if there is an update in the version.
* STEP 2: Running escott with the sif file:
.. code:: bash
singularity exec prescott-docker-v1.6.0.sif escott -h
* STEP 3: Running prescott with the sif file:
.. code:: bash
singularity exec prescott-docker-v1.6.0.sif prescott -h
* STEP 4: Go to the folder where both aliBLAT.fasta and blat-af2.pdb are located.
These two files are provided in the data folder of this repository.
YOUR_SINGULARITY_DIR is where prescott-docker-v1.6.0.sif file is located.
.. code:: bash
singularity exec --home `pwd` $YOUR_SINGULARITY_DIR/prescott-docker-v1.6.0.sif escott aliBLAT.fasta --pdbfile blat-af2.pdb
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment