Skip to content

P
PRESCOTT
Commit 3509620e by Mustafa Tekpinar
Options

Updated the documentation.

parent 7298ac7d
Showing with 1235 additions and 1853 deletions
computePred.R
...@@ -85,10 +85,27 @@ if ((normWeightMode=="max")){ ...@@ -85,10 +85,27 @@ if ((normWeightMode=="max")){
} }
} }
}else if (normWeightMode=="tjetormax"){
print("Using tjetormax")
for (row in 1:nrow(jet)) {
if(sum(colnames(jet)=="traceMax")==1){
if((jet[row, "traceMax"]>jet[row, "pc"]) & (jet[row, "traceMax"]>jet[row, "cv"])){
trace<-append(trace, jet[row, "traceMax"])
}else{
trace<-append(trace, max((jet[row, "traceMax"]+jet[row, "pc"])/2.0, max((jet[row, "traceMax"]+jet[row, "cv"])/2.0, (jet[row, "pc"]+jet[row, "cv"])/2.0 )))
}
}else{
if((jet[row, "trace"]>jet[row, "pc"]) & (jet[row, "trace"]>jet[row, "cv"])){
trace<-append(trace, jet[row, "trace"])
}else{
trace<-append(trace, max((jet[row, "trace"]+jet[row, "pc"])/2.0, max((jet[row, "trace"]+jet[row, "cv"])/2.0, (jet[row, "pc"]+jet[row, "cv"])/2.0 )))
}
}
}
}else{ }else{
print("ERROR: Unknown --normWeightMode selected!") print("ERROR: Unknown --normWeightMode selected!")
print("It can only be 'tjet', 'pc', 'cv',") print("It can only be 'tjet', 'pc', 'cv',")
print("'max' or 'sstjetormax'!") print("'max', 'tjetormax' or 'sstjetormax'!")
} }
print(trace) print(trace)
##################################################################################################################### #####################################################################################################################
......
docs/_build/.buildinfo deleted 100644 → 0
# 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: ee0c3cda5e96b708cc4747fb117bcc00
tags: 645f666f9bcd5a90fca523b33c5a78b7
docs/_build/LICRcyr2utf8.xdy deleted 100644 → 0
;; -*- coding: utf-8; mode: Lisp; -*-
;; style file for xindy
;; filename: LICRcyr2utf8.xdy
;; description: style file for xindy which maps back LaTeX Internal
;; Character Representation of Cyrillic to utf-8
;; usage: for use with pdflatex produced .idx files.
;; Contributed by the Sphinx team, July 2018.
(merge-rule "\IeC {\'\CYRG }" "Ѓ" :string)
(merge-rule "\IeC {\'\CYRK }" "Ќ" :string)
(merge-rule "\IeC {\'\cyrg }" "ѓ" :string)
(merge-rule "\IeC {\'\cyrk }" "ќ" :string)
(merge-rule "\IeC {\CYRA }" "А" :string)
(merge-rule "\IeC {\CYRB }" "Б" :string)
(merge-rule "\IeC {\CYRC }" "Ц" :string)
(merge-rule "\IeC {\CYRCH }" "Ч" :string)
(merge-rule "\IeC {\CYRD }" "Д" :string)
(merge-rule "\IeC {\CYRDJE }" "Ђ" :string)
(merge-rule "\IeC {\CYRDZE }" "Ѕ" :string)
(merge-rule "\IeC {\CYRDZHE }" "Џ" :string)
(merge-rule "\IeC {\CYRE }" "Е" :string)
(merge-rule "\IeC {\CYREREV }" "Э" :string)
(merge-rule "\IeC {\CYRERY }" "Ы" :string)
(merge-rule "\IeC {\CYRF }" "Ф" :string)
(merge-rule "\IeC {\CYRG }" "Г" :string)
(merge-rule "\IeC {\CYRGUP }" "Ґ" :string)
(merge-rule "\IeC {\CYRH }" "Х" :string)
(merge-rule "\IeC {\CYRHRDSN }" "Ъ" :string)
(merge-rule "\IeC {\CYRI }" "И" :string)
(merge-rule "\IeC {\CYRIE }" "Є" :string)
(merge-rule "\IeC {\CYRII }" "І" :string)
(merge-rule "\IeC {\CYRISHRT }" "Й" :string)
(merge-rule "\IeC {\CYRJE }" "Ј" :string)
(merge-rule "\IeC {\CYRK }" "К" :string)
(merge-rule "\IeC {\CYRL }" "Л" :string)
(merge-rule "\IeC {\CYRLJE }" "Љ" :string)
(merge-rule "\IeC {\CYRM }" "М" :string)
(merge-rule "\IeC {\CYRN }" "Н" :string)
(merge-rule "\IeC {\CYRNJE }" "Њ" :string)
(merge-rule "\IeC {\CYRO }" "О" :string)
(merge-rule "\IeC {\CYRP }" "П" :string)
(merge-rule "\IeC {\CYRR }" "Р" :string)
(merge-rule "\IeC {\CYRS }" "С" :string)
(merge-rule "\IeC {\CYRSFTSN }" "Ь" :string)
(merge-rule "\IeC {\CYRSH }" "Ш" :string)
(merge-rule "\IeC {\CYRSHCH }" "Щ" :string)
(merge-rule "\IeC {\CYRT }" "Т" :string)
(merge-rule "\IeC {\CYRTSHE }" "Ћ" :string)
(merge-rule "\IeC {\CYRU }" "У" :string)
(merge-rule "\IeC {\CYRUSHRT }" "Ў" :string)
(merge-rule "\IeC {\CYRV }" "В" :string)
(merge-rule "\IeC {\CYRYA }" "Я" :string)
(merge-rule "\IeC {\CYRYI }" "Ї" :string)
(merge-rule "\IeC {\CYRYO }" "Ё" :string)
(merge-rule "\IeC {\CYRYU }" "Ю" :string)
(merge-rule "\IeC {\CYRZ }" "З" :string)
(merge-rule "\IeC {\CYRZH }" "Ж" :string)
(merge-rule "\IeC {\cyra }" "а" :string)
(merge-rule "\IeC {\cyrb }" "б" :string)
(merge-rule "\IeC {\cyrc }" "ц" :string)
(merge-rule "\IeC {\cyrch }" "ч" :string)
(merge-rule "\IeC {\cyrd }" "д" :string)
(merge-rule "\IeC {\cyrdje }" "ђ" :string)
(merge-rule "\IeC {\cyrdze }" "ѕ" :string)
(merge-rule "\IeC {\cyrdzhe }" "џ" :string)
(merge-rule "\IeC {\cyre }" "е" :string)
(merge-rule "\IeC {\cyrerev }" "э" :string)
(merge-rule "\IeC {\cyrery }" "ы" :string)
(merge-rule "\IeC {\cyrf }" "ф" :string)
(merge-rule "\IeC {\cyrg }" "г" :string)
(merge-rule "\IeC {\cyrgup }" "ґ" :string)
(merge-rule "\IeC {\cyrh }" "х" :string)
(merge-rule "\IeC {\cyrhrdsn }" "ъ" :string)
(merge-rule "\IeC {\cyri }" "и" :string)
(merge-rule "\IeC {\cyrie }" "є" :string)
(merge-rule "\IeC {\cyrii }" "і" :string)
(merge-rule "\IeC {\cyrishrt }" "й" :string)
(merge-rule "\IeC {\cyrje }" "ј" :string)
(merge-rule "\IeC {\cyrk }" "к" :string)
(merge-rule "\IeC {\cyrl }" "л" :string)
(merge-rule "\IeC {\cyrlje }" "љ" :string)
(merge-rule "\IeC {\cyrm }" "м" :string)
(merge-rule "\IeC {\cyrn }" "н" :string)
(merge-rule "\IeC {\cyrnje }" "њ" :string)
(merge-rule "\IeC {\cyro }" "о" :string)
(merge-rule "\IeC {\cyrp }" "п" :string)
(merge-rule "\IeC {\cyrr }" "р" :string)
(merge-rule "\IeC {\cyrs }" "с" :string)
(merge-rule "\IeC {\cyrsftsn }" "ь" :string)
(merge-rule "\IeC {\cyrsh }" "ш" :string)
(merge-rule "\IeC {\cyrshch }" "щ" :string)
(merge-rule "\IeC {\cyrt }" "т" :string)
(merge-rule "\IeC {\cyrtshe }" "ћ" :string)
(merge-rule "\IeC {\cyru }" "у" :string)
(merge-rule "\IeC {\cyrushrt }" "ў" :string)
(merge-rule "\IeC {\cyrv }" "в" :string)
(merge-rule "\IeC {\cyrya }" "я" :string)
(merge-rule "\IeC {\cyryi }" "ї" :string)
(merge-rule "\IeC {\cyryo }" "ё" :string)
(merge-rule "\IeC {\cyryu }" "ю" :string)
(merge-rule "\IeC {\cyrz }" "з" :string)
(merge-rule "\IeC {\cyrzh }" "ж" :string)
docs/_build/Makefile deleted 100644 → 0
# Makefile for Sphinx LaTeX output
ALLDOCS = $(basename $(wildcard *.tex))
ALLPDF = $(addsuffix .pdf,$(ALLDOCS))
ALLDVI = $(addsuffix .dvi,$(ALLDOCS))
ALLXDV =
ALLPS = $(addsuffix .ps,$(ALLDOCS))
ALLIMGS = $(wildcard *.png *.gif *.jpg *.jpeg)
# Prefix for archive names
ARCHIVEPREFIX =
# Additional LaTeX options (passed via variables in latexmkrc/latexmkjarc file)
export LATEXOPTS ?=
# Additional latexmk options
LATEXMKOPTS ?=
# format: pdf or dvi (used only by archive targets)
FMT = pdf
LATEX = latexmk -dvi
PDFLATEX = latexmk -pdf -dvi- -ps-
%.png %.gif %.jpg %.jpeg: FORCE_MAKE
extractbb '$@'
%.dvi: %.tex FORCE_MAKE
$(LATEX) $(LATEXMKOPTS) '$<'
%.ps: %.dvi
dvips '$<'
%.pdf: %.tex FORCE_MAKE
$(PDFLATEX) $(LATEXMKOPTS) '$<'
all: $(ALLPDF)
all-dvi: $(ALLDVI)
all-ps: $(ALLPS)
all-pdf: $(ALLPDF)
zip: all-$(FMT)
mkdir $(ARCHIVEPREFIX)docs-$(FMT)
cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT)
zip -q -r -9 $(ARCHIVEPREFIX)docs-$(FMT).zip $(ARCHIVEPREFIX)docs-$(FMT)
rm -r $(ARCHIVEPREFIX)docs-$(FMT)
tar: all-$(FMT)
mkdir $(ARCHIVEPREFIX)docs-$(FMT)
cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT)
tar cf $(ARCHIVEPREFIX)docs-$(FMT).tar $(ARCHIVEPREFIX)docs-$(FMT)
rm -r $(ARCHIVEPREFIX)docs-$(FMT)
gz: tar
gzip -9 < $(ARCHIVEPREFIX)docs-$(FMT).tar > $(ARCHIVEPREFIX)docs-$(FMT).tar.gz
bz2: tar
bzip2 -9 -k $(ARCHIVEPREFIX)docs-$(FMT).tar
xz: tar
xz -9 -k $(ARCHIVEPREFIX)docs-$(FMT).tar
clean:
rm -f *.log *.ind *.aux *.toc *.syn *.idx *.out *.ilg *.pla *.ps *.tar *.tar.gz *.tar.bz2 *.tar.xz $(ALLPDF) $(ALLDVI) $(ALLXDV) *.fls *.fdb_latexmk
.PHONY: all all-pdf all-dvi all-ps clean zip tar gz bz2 xz
.PHONY: FORCE_MAKE
\ No newline at end of file
docs/_build/_sources/docker.rst.txt deleted 100644 → 0
Using ESGEMME via Docker
========================
Requirements
------------
You need to have docker installed on your machine. You can consult the
following page for this: https://docs.docker.com/get-docker/
I am assuming some basic familiarity with Linux/Unix/MacOS terminal
commands.
Let’s start our favorite terminal app.
You must to create a folder called docker-tutorial and go to that empty
folder:
.. code:: bash
mkdir docker-tutorial
cd docker-tutorial
Getting the input data
----------------------
Let’s download the sample data provided in the ESGEMME repository for
this exercise. First, we will download the multiple sequence alignment
file in fasta format:
.. code:: bash
wget http://gitlab.lcqb.upmc.fr/tekpinar/ESGEMME/blob/master/data/aliBLAT.fasta
If you don’t have wget, you can try the same command with curl:
.. code:: bash
curl http://gitlab.lcqb.upmc.fr/tekpinar/ESGEMME/blob/master/data/aliBLAT.fasta
Please verify that the aliBLAT.fasta file is in the folder.
Now, we will download the PDB (Protein Databank) file for BLAT:
.. code:: bash
wget http://gitlab.lcqb.upmc.fr/tekpinar/ESGEMME/blob/master/data/blat-af2.pdb
Single point mutation calculations
----------------------------------
In order to make sure that the docker is installed:
.. code:: bash
sudo docker -h
If it shows you a list of options, you are on a good track. On MacOS,
you may not need ‘sudo’ word before the docker command at all.
.. code:: bash
sudo docker run -ti --rm --mount type=bind,source=$PWD,target=/home/tekpinar/research/myexample \
tekpinar/esgemme-docker:v1.3.0
You are in the container (your virtual operating system) now. You
created a folder called myexample in your container with the previous
command. Let’s change to that folder.
.. code:: bash
cd ../myexample/
When you check the data in that folder with ‘ls’ command, you are
supposed to see aliBLAT.fasta and blat-af2.pdb files. Basically, your
docker-tutorial folder on the host system and myexample folder on the
docker container are pointing to the same place.
Obtaining the entire single point mutation landscape
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
In this step, we will use only evolutionary information from an MSA file:
.. code:: bash
python $ESGEMME_PATH/esgemme.py aliBLAT.fasta -r input -f aliBLAT.fasta
After a few minutes of calculation, you must see at least two files named
BLAT_normPred_evolCombi.txt and BLAT_normPred_evolCombi.png. You have
the entire single point mutational landscape of BLAT protein in these
files.
If you want to utilize structural information (highly recommended) as well as
evolutionary information:
.. code:: bash
python $ESGEMME_PATH/esgemme.py aliBLAT.fasta -r input -f aliBLAT.fasta \
--pdbfile blat-af2.pdb \
--normweightmode sstjetormax
Obtaining the effect of a subset of single point mutations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you are interested in only a bunch of single point mutations,
you have to prepare a mut file. The format is a simple text file and
each line contains a single point mutation such as D26A....
Fortunately, we have an example mut in data folder of ESGEMME repository.
.. code:: bash
wget http://gitlab.lcqb.upmc.fr/tekpinar/ESGEMME/raw/master/data/Stiffler_2015_BLAT_ECOLX.mut
Similar to the previous step, there are two possible ways to do the calculations: with or without
structural information. First, without structural information:
.. code:: bash
python $ESGEMME_PATH/esgemme.py aliBLAT.fasta -r input -f aliBLAT.fasta \
-m Stiffler_2015_BLAT_ECOLX.mut
You can include structural information in the following way:
.. code:: bash
python $ESGEMME_PATH/esgemme.py aliBLAT.fasta -r input -f aliBLAT.fasta \
--pdbfile blat-af2.pdb \
--normweightmode sstjetormax \
-m Stiffler_2015_BLAT_ECOLX.mut
You will have BLAT_normPred_evolCombi.txt file in your folder. However, the output
format is completely different from the entire mutational landscape scanning file.
Each line of this file is a mutation and its predicted effect separated by a space.
In addition, you won't have a png file like in the previous case.
Multiple point mutation calculations
------------------------------------
Sometimes, we need to see effects of double or triple mutations. ESGEMME can
perform calculations if you provide a mut file. In this case, the mut file must
have the following format:
.. code:: bash
E26D:Y44R
E56N:A77F:H94V
The first line of the text file is impact of a double mutations and the second
line is the impact of the triple mutations. As you can see, the mutations are
separated by a colon(:) character.
The output file will be in a similar format. Each line will contain the multiple
mutation and its predicted effect, separated by a space.
Running several jobs using docker
---------------------------------
docs/_build/_sources/index.rst.txt deleted 100644 → 0
.. esgemme documentation master file, created by
sphinx-quickstart on Fri May 5 13:52:13 2023.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to esgemme's documentation!
===================================
.. toctree::
:maxdepth: 2
:caption: Contents:
docker.rst
analysis.rst
installation.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
docs/_build/_static/custom.css deleted 100644 → 0
/* This file intentionally left blank. */
docs/_build/_static/documentation_options.js deleted 100644 → 0
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '1.3.0',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt',
NAVIGATION_WITH_KEYS: false
};
\ No newline at end of file
docs/_build/_static/jquery-3.4.1.js deleted 100644 → 0
This source diff could not be displayed because it is too large. You can view the blob instead.
docs/_build/_static/pygments.css deleted 100644 → 0
.highlight .hll { background-color: #ffffcc }
.highlight { background: #f8f8f8; }
.highlight .c { color: #408080; font-style: italic } /* Comment */
.highlight .err { border: 1px solid #FF0000 } /* Error */
.highlight .k { color: #008000; font-weight: bold } /* Keyword */
.highlight .o { color: #666666 } /* Operator */
.highlight .ch { color: #408080; font-style: italic } /* Comment.Hashbang */
.highlight .cm { color: #408080; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #BC7A00 } /* Comment.Preproc */
.highlight .cpf { color: #408080; font-style: italic } /* Comment.PreprocFile */
.highlight .c1 { color: #408080; font-style: italic } /* Comment.Single */
.highlight .cs { color: #408080; font-style: italic } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.highlight .gt { color: #0044DD } /* Generic.Traceback */
.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008000 } /* Keyword.Pseudo */
.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #B00040 } /* Keyword.Type */
.highlight .m { color: #666666 } /* Literal.Number */
.highlight .s { color: #BA2121 } /* Literal.String */
.highlight .na { color: #7D9029 } /* Name.Attribute */
.highlight .nb { color: #008000 } /* Name.Builtin */
.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
.highlight .no { color: #880000 } /* Name.Constant */
.highlight .nd { color: #AA22FF } /* Name.Decorator */
.highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */
.highlight .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0000FF } /* Name.Function */
.highlight .nl { color: #A0A000 } /* Name.Label */
.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #19177C } /* Name.Variable */
.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #666666 } /* Literal.Number.Bin */
.highlight .mf { color: #666666 } /* Literal.Number.Float */
.highlight .mh { color: #666666 } /* Literal.Number.Hex */
.highlight .mi { color: #666666 } /* Literal.Number.Integer */
.highlight .mo { color: #666666 } /* Literal.Number.Oct */
.highlight .sa { color: #BA2121 } /* Literal.String.Affix */
.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
.highlight .sc { color: #BA2121 } /* Literal.String.Char */
.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */
.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #BA2121 } /* Literal.String.Double */
.highlight .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */
.highlight .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
.highlight .sx { color: #008000 } /* Literal.String.Other */
.highlight .sr { color: #BB6688 } /* Literal.String.Regex */
.highlight .s1 { color: #BA2121 } /* Literal.String.Single */
.highlight .ss { color: #19177C } /* Literal.String.Symbol */
.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #0000FF } /* Name.Function.Magic */
.highlight .vc { color: #19177C } /* Name.Variable.Class */
.highlight .vg { color: #19177C } /* Name.Variable.Global */
.highlight .vi { color: #19177C } /* Name.Variable.Instance */
.highlight .vm { color: #19177C } /* Name.Variable.Magic */
.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */
\ No newline at end of file
docs/_build/footnotehyper-sphinx.sty deleted 100644 → 0
\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{footnotehyper-sphinx}%
[2017/10/27 v1.7 hyperref aware footnote.sty for sphinx (JFB)]
%%
%% Package: footnotehyper-sphinx
%% Version: based on footnotehyper.sty 2017/03/07 v1.0
%% as available at https://www.ctan.org/pkg/footnotehyper
%% License: the one applying to Sphinx
%%
%% Refer to the PDF documentation at https://www.ctan.org/pkg/footnotehyper for
%% the code comments.
%%
%% Differences:
%% 1. a partial tabulary compatibility layer added (enough for Sphinx mark-up),
%% 2. use of \spx@opt@BeforeFootnote from sphinx.sty,
%% 3. use of \sphinxunactivateextrasandspace from sphinx.sty,
%% 4. macro definition \sphinxfootnotemark,
%% 5. macro definition \sphinxlongtablepatch
%% 6. replaced an \undefined by \@undefined
\DeclareOption*{\PackageWarning{footnotehyper-sphinx}{Option `\CurrentOption' is unknown}}%
\ProcessOptions\relax
\newbox\FNH@notes
\newdimen\FNH@width
\let\FNH@colwidth\columnwidth
\newif\ifFNH@savingnotes
\AtBeginDocument {%
\let\FNH@latex@footnote \footnote
\let\FNH@latex@footnotetext\footnotetext
\let\FNH@H@@footnotetext \@footnotetext
\newenvironment{savenotes}
{\FNH@savenotes\ignorespaces}{\FNH@spewnotes\ignorespacesafterend}%
\let\spewnotes \FNH@spewnotes
\let\footnote \FNH@footnote
\let\footnotetext \FNH@footnotetext
\let\endfootnote \FNH@endfntext
\let\endfootnotetext\FNH@endfntext
\@ifpackageloaded{hyperref}
{\ifHy@hyperfootnotes
\let\FNH@H@@footnotetext\H@@footnotetext
\else
\let\FNH@hyper@fntext\FNH@nohyp@fntext
\fi}%
{\let\FNH@hyper@fntext\FNH@nohyp@fntext}%
}%
\def\FNH@hyper@fntext{\FNH@fntext\FNH@hyper@fntext@i}%
\def\FNH@nohyp@fntext{\FNH@fntext\FNH@nohyp@fntext@i}%
\def\FNH@fntext #1{%
\ifx\ifmeasuring@\@undefined
\expandafter\@secondoftwo\else\expandafter\@firstofone\fi
% these two lines modified for Sphinx (tabulary compatibility):
{\ifmeasuring@\expandafter\@gobbletwo\else\expandafter\@firstofone\fi}%
{\ifx\equation$\expandafter\@gobbletwo\fi #1}%$
}%
\long\def\FNH@hyper@fntext@i#1{%
\global\setbox\FNH@notes\vbox
{\unvbox\FNH@notes
\FNH@startnote
\@makefntext
{\rule\z@\footnotesep\ignorespaces
\ifHy@nesting\expandafter\ltx@firstoftwo
\else\expandafter\ltx@secondoftwo
\fi
{\expandafter\hyper@@anchor\expandafter{\Hy@footnote@currentHref}{#1}}%
{\Hy@raisedlink
{\expandafter\hyper@@anchor\expandafter{\Hy@footnote@currentHref}%
{\relax}}%
\let\@currentHref\Hy@footnote@currentHref
\let\@currentlabelname\@empty
#1}%
\@finalstrut\strutbox
}%
\FNH@endnote
}%
}%
\long\def\FNH@nohyp@fntext@i#1{%
\global\setbox\FNH@notes\vbox
{\unvbox\FNH@notes
\FNH@startnote
\@makefntext{\rule\z@\footnotesep\ignorespaces#1\@finalstrut\strutbox}%
\FNH@endnote
}%
}%
\def\FNH@startnote{%
\hsize\FNH@colwidth
\interlinepenalty\interfootnotelinepenalty
\reset@font\footnotesize
\floatingpenalty\@MM
\@parboxrestore
\protected@edef\@currentlabel{\csname p@\@mpfn\endcsname\@thefnmark}%
\color@begingroup
}%
\def\FNH@endnote{\color@endgroup}%
\def\FNH@savenotes{%
\begingroup
\ifFNH@savingnotes\else
\FNH@savingnotestrue
\let\@footnotetext \FNH@hyper@fntext
\let\@mpfootnotetext \FNH@hyper@fntext
\let\H@@mpfootnotetext\FNH@nohyp@fntext
\FNH@width\columnwidth
\let\FNH@colwidth\FNH@width
\global\setbox\FNH@notes\box\voidb@x
\let\FNH@thempfn\thempfn
\let\FNH@mpfn\@mpfn
\ifx\@minipagerestore\relax\let\@minipagerestore\@empty\fi
\expandafter\def\expandafter\@minipagerestore\expandafter{%
\@minipagerestore
\let\thempfn\FNH@thempfn
\let\@mpfn\FNH@mpfn
}%
\fi
}%
\def\FNH@spewnotes {%
\endgroup
\ifFNH@savingnotes\else
\ifvoid\FNH@notes\else
\begingroup
\let\@makefntext\@empty
\let\@finalstrut\@gobble
\let\rule\@gobbletwo
\FNH@H@@footnotetext{\unvbox\FNH@notes}%
\endgroup
\fi
\fi
}%
\def\FNH@footnote@envname {footnote}%
\def\FNH@footnotetext@envname{footnotetext}%
\def\FNH@footnote{%
% this line added for Sphinx:
\spx@opt@BeforeFootnote
\ifx\@currenvir\FNH@footnote@envname
\expandafter\FNH@footnoteenv
\else
\expandafter\FNH@latex@footnote
\fi
}%
\def\FNH@footnoteenv{%
% this line added for Sphinx (footnotes in parsed literal blocks):
\catcode13=5 \sphinxunactivateextrasandspace
\@ifnextchar[%
\FNH@footnoteenv@i %]
{\stepcounter\@mpfn
\protected@xdef\@thefnmark{\thempfn}%
\@footnotemark
\def\FNH@endfntext@fntext{\@footnotetext}%
\FNH@startfntext}%
}%
\def\FNH@footnoteenv@i[#1]{%
\begingroup
\csname c@\@mpfn\endcsname #1\relax
\unrestored@protected@xdef\@thefnmark{\thempfn}%
\endgroup
\@footnotemark
\def\FNH@endfntext@fntext{\@footnotetext}%
\FNH@startfntext
}%
\def\FNH@footnotetext{%
\ifx\@currenvir\FNH@footnotetext@envname
\expandafter\FNH@footnotetextenv
\else
\expandafter\FNH@latex@footnotetext
\fi
}%
\def\FNH@footnotetextenv{%
\@ifnextchar[%
\FNH@footnotetextenv@i %]
{\protected@xdef\@thefnmark{\thempfn}%
\def\FNH@endfntext@fntext{\@footnotetext}%
\FNH@startfntext}%
}%
\def\FNH@footnotetextenv@i[#1]{%
\begingroup
\csname c@\@mpfn\endcsname #1\relax
\unrestored@protected@xdef\@thefnmark{\thempfn}%
\endgroup
\ifFNH@savingnotes
\def\FNH@endfntext@fntext{\FNH@nohyp@fntext}%
\else
\def\FNH@endfntext@fntext{\FNH@H@@footnotetext}%
\fi
\FNH@startfntext
}%
\def\FNH@startfntext{%
\setbox\z@\vbox\bgroup
\FNH@startnote
\FNH@prefntext
\rule\z@\footnotesep\ignorespaces
}%
\def\FNH@endfntext {%
\@finalstrut\strutbox
\FNH@postfntext
\FNH@endnote
\egroup
\begingroup
\let\@makefntext\@empty\let\@finalstrut\@gobble\let\rule\@gobbletwo
\FNH@endfntext@fntext {\unvbox\z@}%
\endgroup
}%
\AtBeginDocument{%
\let\FNH@@makefntext\@makefntext
\ifx\@makefntextFB\@undefined
\expandafter\@gobble\else\expandafter\@firstofone\fi
{\ifFBFrenchFootnotes \let\FNH@@makefntext\@makefntextFB \else
\let\FNH@@makefntext\@makefntextORI\fi}%
\expandafter\FNH@check@a\FNH@@makefntext{1.2!3?4,}%
\FNH@@@1.2!3?4,\FNH@@@\relax
}%
\long\def\FNH@check@a #11.2!3?4,#2\FNH@@@#3{%
\ifx\relax#3\expandafter\@firstoftwo\else\expandafter\@secondoftwo\fi
\FNH@bad@makefntext@alert
{\def\FNH@prefntext{#1}\def\FNH@postfntext{#2}\FNH@check@b}%
}%
\def\FNH@check@b #1\relax{%
\expandafter\expandafter\expandafter\FNH@check@c
\expandafter\meaning\expandafter\FNH@prefntext
\meaning\FNH@postfntext1.2!3?4,\FNH@check@c\relax
}%
\def\FNH@check@c #11.2!3?4,#2#3\relax{%
\ifx\FNH@check@c#2\expandafter\@gobble\fi\FNH@bad@makefntext@alert
}%
% slight reformulation for Sphinx
\def\FNH@bad@makefntext@alert{%
\PackageWarningNoLine{footnotehyper-sphinx}%
{Footnotes will be sub-optimal, sorry. This is due to the document class or^^J
some package modifying macro \string\@makefntext.^^J
You can try to report this incompatibility at^^J
https://github.com/sphinx-doc/sphinx with this info:}%
\typeout{\meaning\@makefntext}%
\let\FNH@prefntext\@empty\let\FNH@postfntext\@empty
}%
% this macro from original footnote.sty is not used anymore by Sphinx
% but for simplicity sake let's just keep it as is
\def\makesavenoteenv{\@ifnextchar[\FNH@msne@ii\FNH@msne@i}%]
\def\FNH@msne@i #1{%
\expandafter\let\csname FNH$#1\expandafter\endcsname %$
\csname #1\endcsname
\expandafter\let\csname endFNH$#1\expandafter\endcsname %$
\csname end#1\endcsname
\FNH@msne@ii[#1]{FNH$#1}%$
}%
\def\FNH@msne@ii[#1]#2{%
\expandafter\edef\csname#1\endcsname{%
\noexpand\savenotes
\expandafter\noexpand\csname#2\endcsname
}%
\expandafter\edef\csname end#1\endcsname{%
\expandafter\noexpand\csname end#2\endcsname
\noexpand\expandafter
\noexpand\spewnotes
\noexpand\if@endpe\noexpand\@endpetrue\noexpand\fi
}%
}%
% end of footnotehyper 2017/02/16 v0.99
% some extras for Sphinx :
% \sphinxfootnotemark: usable in section titles and silently removed from TOCs.
\def\sphinxfootnotemark [#1]%
{\ifx\thepage\relax\else\protect\spx@opt@BeforeFootnote
\protect\footnotemark[#1]\fi}%
\AtBeginDocument{%
% let hyperref less complain
\pdfstringdefDisableCommands{\def\sphinxfootnotemark [#1]{}}%
% to obtain hyperlinked footnotes in longtable environment we must replace
% hyperref's patch of longtable's patch of \@footnotetext by our own
\let\LT@p@ftntext\FNH@hyper@fntext
% this *requires* longtable to be used always wrapped in savenotes environment
}%
\endinput
%%
%% End of file `footnotehyper-sphinx.sty'.
docs/_build/html/.buildinfo
# Sphinx build info version 1 # 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. # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 2b63f8059aa2ad903c52bf6ea56d7c9d config: 1d56d17901c6f429146d20c07a73dc21
tags: 645f666f9bcd5a90fca523b33c5a78b7 tags: 645f666f9bcd5a90fca523b33c5a78b7
docs/_build/html/_sources/docker.rst.txt
...@@ -12,7 +12,7 @@ commands. ...@@ -12,7 +12,7 @@ commands.
Let’s start our favorite terminal app. Let’s start our favorite terminal app.
You must to create a folder called docker-tutorial and go to that empty You must create a folder called docker-tutorial and go to that empty
folder: folder:
.. code:: bash .. code:: bash
...@@ -20,8 +20,8 @@ folder: ...@@ -20,8 +20,8 @@ folder:
mkdir docker-tutorial mkdir docker-tutorial
cd docker-tutorial cd docker-tutorial
Getting the input data Getting the example input data
---------------------- ------------------------------
Let’s download the sample data provided in the ESGEMME repository for Let’s download the sample data provided in the ESGEMME repository for
this exercise. First, we will download the multiple sequence alignment this exercise. First, we will download the multiple sequence alignment
...@@ -45,21 +45,22 @@ Now, we will download the PDB (Protein Databank) file for BLAT: ...@@ -45,21 +45,22 @@ Now, we will download the PDB (Protein Databank) file for BLAT:
wget http://gitlab.lcqb.upmc.fr/tekpinar/ESGEMME/blob/master/data/blat-af2.pdb wget http://gitlab.lcqb.upmc.fr/tekpinar/ESGEMME/blob/master/data/blat-af2.pdb
Running a calculation for a single sequence/protein Single point mutation calculations
--------------------------------------------------- ----------------------------------
In order to make sure that the docker is installed: In order to make sure that the docker is installed:
.. code:: bash .. code:: bash
docker -h sudo docker -h
If it shows you a list of options, you are on a good track. On MacOS, If it shows you a list of options, you are on a good track. On MacOS,
you may not need ‘sudo’ word before the docker command at all. you may not need ‘sudo’ word before the docker command at all.
.. code:: bash .. code:: bash
sudo docker run -ti --rm --mount type=bind,source=$PWD,target=/home/tekpinar/research/myexample tekpinar/esgemme-docker:v1.3.0 sudo docker run -ti --rm --mount type=bind,source=$PWD,target=/home/tekpinar/research/myexample \
tekpinar/esgemme-docker:v1.3.0
You are in the container (your virtual operating system) now. You You are in the container (your virtual operating system) now. You
created a folder called myexample in your container with the previous created a folder called myexample in your container with the previous
...@@ -74,16 +75,77 @@ supposed to see aliBLAT.fasta and blat-af2.pdb files. Basically, your ...@@ -74,16 +75,77 @@ supposed to see aliBLAT.fasta and blat-af2.pdb files. Basically, your
docker-tutorial folder on the host system and myexample folder on the docker-tutorial folder on the host system and myexample folder on the
docker container are pointing to the same place. docker container are pointing to the same place.
One last step and we are done: Obtaining the entire single point mutation landscape
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
In this step, we will use only evolutionary information from an MSA file:
.. code:: bash .. code:: bash
python $ESGEMME_PATH/esgemme.py aliBLAT.fasta -r input -f aliBLAT.fasta --pdbfile blat-af2.pdb python $ESGEMME_PATH/esgemme.py aliBLAT.fasta -r input -f aliBLAT.fasta
After a few minutes of calculation, you must see two files named After a few minutes of calculation, you must see at least two files named
BLAT_normPred_evolCombi.txt and BLAT_normPred_evolCombi.png. You have BLAT_normPred_evolCombi.txt and BLAT_normPred_evolCombi.png. You have
the entire single point mutational landscape of BLAT protein in these the entire single point mutational landscape of BLAT protein in these
files. files.
If you want to utilize structural information (highly recommended) as well as
evolutionary information:
.. code:: bash
python $ESGEMME_PATH/esgemme.py aliBLAT.fasta -r input -f aliBLAT.fasta \
--pdbfile blat-af2.pdb \
--normweightmode sstjetormax
Predicting the effect of a subset of single point mutations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you are interested in only a bunch of single point mutations,
you have to prepare a mut file. The format is a simple text file and
each line contains a single point mutation such as D26A....
Fortunately, we have an example mut in data folder of ESGEMME repository.
.. code:: bash
wget http://gitlab.lcqb.upmc.fr/tekpinar/ESGEMME/raw/master/data/Stiffler_2015_BLAT_ECOLX.mut
Similar to the previous step, there are two possible ways to do the calculations: with or without
structural information. First, let's do it without structural information:
.. code:: bash
python $ESGEMME_PATH/esgemme.py aliBLAT.fasta -r input -f aliBLAT.fasta \
-m Stiffler_2015_BLAT_ECOLX.mut
You can include structural information in the following way:
.. code:: bash
python $ESGEMME_PATH/esgemme.py aliBLAT.fasta -r input -f aliBLAT.fasta \
--pdbfile blat-af2.pdb \
--normweightmode sstjetormax \
-m Stiffler_2015_BLAT_ECOLX.mut
You will have BLAT_normPred_evolCombi.txt file in your folder. However, the output
format is completely different from the entire mutational landscape scanning file.
Each line of this file is a mutation and its predicted effect separated by a space.
In addition, you won't have a png file like in the previous case.
Multiple point mutation calculations
------------------------------------
Sometimes, we need to see effects of double or triple mutations. ESGEMME can
perform calculations if you provide a mut file. In this case, the mut file must
have the following format:
.. code:: bash
E26D:Y44R
E56N:A77F:H94V
The first line of the text file is impact of a double mutation and the second
line is the impact of the triple mutations. As you can see, the mutations are
separated by a colon(:) character.
The output file will be in a similar format. Each line will contain the multiple
mutation and its predicted effect, separated by a space.
Running several jobs using docker Running several jobs using docker
--------------------------------- ---------------------------------
docs/_build/html/_sources/index.rst.txt
...@@ -11,6 +11,9 @@ Welcome to esgemme's documentation! ...@@ -11,6 +11,9 @@ Welcome to esgemme's documentation!
:caption: Contents: :caption: Contents:
docker.rst docker.rst
analysis.rst
input-preparation.rst
installation.rst
Indices and tables Indices and tables
================== ==================
......
docs/_build/html/_sources/input-preparation.rst.txt 0 → 100644
Preparing Your Own Input
========================
Preparing Your Input MSA and PDB with Colabfold
-----------------------------------------------
You have a fasta file for your protein of interest and you want to understand
impact of (certain) mutations.
Before starting, please make sure that your fasta file does not contain a gap.
The quickest method to obtain both multiple sequence alignment and a protein
structure is to use Colabfold. Let's do this step by step:
1. Let's go the Colabfold web site:
https://colab.research.google.com/github/sokrypton/ColabFold/blob/main/AlphaFold2.ipynb
Sign in using your gmail account.
2. Click on the 'Connect' button on the top right hand side.
3. Clean 'query_sequence' box and paste your sequence to the 'query_sequence' box.
For me, I selected adenylate kinase (AKE) as my example fasta sequence
(https://www.rcsb.org/fasta/entry/4AKE/display).
4. Change the 'jobname' to something that makes more sense to you.
5. Go to the menu bar of your 'AlphaFold2.ipynb' notebook, where 'File, Edit,
View, Insert, Runtime, Tools, Help' are listed. Click on the Runtime and
select 'Run all'.
6. This process make take from a few minutes to a few hours depending on your
protein size. It will give you an a3m file and up to 5 PDB models. Put these
files in a clean folder and change the directory to that folder in your
terminal.
7. Unfortunately, a3m file is not in fasta format and it contains gap columns.
We have to clean those gaps. We can do that with a GUI program like Ugene
or Jalview. However, it is a labor intensive procedure. Here, I will use a
small tool that I developed and added to the ESGEMME docker image that I created.
8. Start the docker image with the following command:
.. code:: bash
sudo docker run -ti --rm --mount type=bind,source=$PWD,target=/home/tekpinar/research/myexample \
tekpinar/esgemme-docker:v1.3.0
9. Now, change the directory to myexample folder.
.. code:: bash
cd ../myexample/
ls -l
We are supposed to see our a3m and pdb files in this folder.
10. Let's use a small script from hhsuite to convert a3m file to fasta format.
.. code:: bash
reformat.pl a3m fas AKE.a3m AKE.fasta
11. Final step and we are there:
.. code:: bash
demust removegaps -i AKE.fasta -o AKE_nogaps.fasta
Congratulations! Now, you have all the input files required for ESGEMME:
I. An input MSA: AKE_nogaps.fasta
II. An input PDB: myprotein.pdb
docs/_build/_sources/installation.rst.txt → docs/_build/html/_sources/installation.rst.txt
...@@ -9,12 +9,16 @@ steps required to install it from the source. ...@@ -9,12 +9,16 @@ steps required to install it from the source.
Installing the dependencies: Installing the dependencies:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ESGEMME has the following external dependencies: \* Joint Evolutionary ESGEMME has the following external dependencies:
Trees: http://www.lcqb.upmc.fr/JET2/ and its dependencies: - naccess:
http://www.bioinf.manchester.ac.uk/naccess/ - muscle: * Joint Evolutionary Trees: http://www.lcqb.upmc.fr/JET2/ and its dependencies:
https://www.drive5.com/muscle/ \*\* \* seqinr R package:
https://cran.r-project.org/web/packages/seqinr/index.html \* dssp for * java
secondary structure prediction. * naccess: http://www.bioinf.manchester.ac.uk/naccess/
* muscle: https://www.drive5.com/muscle/
* seqinr R package: https://cran.r-project.org/web/packages/seqinr/index.html
* dssp for secondary structure prediction.
These tools should be installed to be able to use ESGEMME. These tools should be installed to be able to use ESGEMME.
......
docs/_build/_static/doctools.js → docs/_build/html/_static/_sphinx_javascript_frameworks_compat.js
/* /* Compatability shim for jQuery and underscores.js.
* doctools.js
* ~~~~~~~~~~~
*
* Sphinx JavaScript utilities for all documentation.
* *
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. * Copyright Sphinx contributors
* :license: BSD, see LICENSE for details. * Released under the two clause BSD licence
*
*/
/**
* select a different prefix for underscore
*/
$u = _.noConflict();
/**
* make the code below compatible with browsers without
* an installed firebug like debugger
if (!window.console || !console.firebug) {
var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
"dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
"profile", "profileEnd"];
window.console = {};
for (var i = 0; i < names.length; ++i)
window.console[names[i]] = function() {};
}
*/ */
/** /**
* small helper function to urldecode strings * small helper function to urldecode strings
*
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
*/ */
jQuery.urldecode = function(x) { jQuery.urldecode = function(x) {
return decodeURIComponent(x).replace(/\+/g, ' '); if (!x) {
return x
}
return decodeURIComponent(x.replace(/\+/g, ' '));
}; };
/** /**
...@@ -139,177 +121,3 @@ if (!jQuery.browser) { ...@@ -139,177 +121,3 @@ if (!jQuery.browser) {
jQuery.browser = {}; jQuery.browser = {};
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
} }
/**
* Small JavaScript module for the documentation.
*/
var Documentation = {
init : function() {
this.fixFirefoxAnchorBug();
this.highlightSearchWords();
this.initIndexTable();
if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
this.initOnKeyListeners();
}
},
/**
* i18n support
*/
TRANSLATIONS : {},
PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
LOCALE : 'unknown',
// gettext and ngettext don't access this so that the functions
// can safely bound to a different name (_ = Documentation.gettext)
gettext : function(string) {
var translated = Documentation.TRANSLATIONS[string];
if (typeof translated === 'undefined')
return string;
return (typeof translated === 'string') ? translated : translated[0];
},
ngettext : function(singular, plural, n) {
var translated = Documentation.TRANSLATIONS[singular];
if (typeof translated === 'undefined')
return (n == 1) ? singular : plural;
return translated[Documentation.PLURALEXPR(n)];
},
addTranslations : function(catalog) {
for (var key in catalog.messages)
this.TRANSLATIONS[key] = catalog.messages[key];
this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
this.LOCALE = catalog.locale;
},
/**
* add context elements like header anchor links
*/
addContextElements : function() {
$('div[id] > :header:first').each(function() {
$('<a class="headerlink">\u00B6</a>').
attr('href', '#' + this.id).
attr('title', _('Permalink to this headline')).
appendTo(this);
});
$('dt[id]').each(function() {
$('<a class="headerlink">\u00B6</a>').
attr('href', '#' + this.id).
attr('title', _('Permalink to this definition')).
appendTo(this);
});
},
/**
* workaround a firefox stupidity
* see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
*/
fixFirefoxAnchorBug : function() {
if (document.location.hash && $.browser.mozilla)
window.setTimeout(function() {
document.location.href += '';
}, 10);
},
/**
* highlight the search words provided in the url in the text
*/
highlightSearchWords : function() {
var params = $.getQueryParameters();
var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
if (terms.length) {
var body = $('div.body');
if (!body.length) {
body = $('body');
}
window.setTimeout(function() {
$.each(terms, function() {
body.highlightText(this.toLowerCase(), 'highlighted');
});
}, 10);
$('<p class="highlight-link"><a href="javascript:Documentation.' +
'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
.appendTo($('#searchbox'));
}
},
/**
* init the domain index toggle buttons
*/
initIndexTable : function() {
var togglers = $('img.toggler').click(function() {
var src = $(this).attr('src');
var idnum = $(this).attr('id').substr(7);
$('tr.cg-' + idnum).toggle();
if (src.substr(-9) === 'minus.png')
$(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
else
$(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
}).css('display', '');
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
togglers.click();
}
},
/**
* helper function to hide the search marks again
*/
hideSearchWords : function() {
$('#searchbox .highlight-link').fadeOut(300);
$('span.highlighted').removeClass('highlighted');
},
/**
* make the url absolute
*/
makeURL : function(relativeURL) {
return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
},
/**
* get the current relative url
*/
getCurrentURL : function() {
var path = document.location.pathname;
var parts = path.split(/\//);
$.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
if (this === '..')
parts.pop();
});
var url = parts.join('/');
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
},
initOnKeyListeners: function() {
$(document).keydown(function(event) {
var activeElementType = document.activeElement.tagName;
// don't navigate when in search box or textarea
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
&& !event.altKey && !event.ctrlKey && !event.metaKey && !event.shiftKey) {
switch (event.keyCode) {
case 37: // left
var prevHref = $('link[rel="prev"]').prop('href');
if (prevHref) {
window.location.href = prevHref;
return false;
}
case 39: // right
var nextHref = $('link[rel="next"]').prop('href');
if (nextHref) {
window.location.href = nextHref;
return false;
}
}
}
});
}
};
// quick alias for translations
_ = Documentation.gettext;
$(document).ready(function() {
Documentation.init();
});
docs/_build/html/_static/custom.css deleted 100644 → 0
/* This file intentionally left blank. */
docs/_build/html/_static/documentation_options.js
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '1.3.0', VERSION: '1.3.0',
LANGUAGE: 'None', LANGUAGE: 'en',
COLLAPSE_INDEX: false, COLLAPSE_INDEX: false,
BUILDER: 'html', BUILDER: 'html',
FILE_SUFFIX: '.html', FILE_SUFFIX: '.html',
LINK_SUFFIX: '.html',
HAS_SOURCE: true, HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt', SOURCELINK_SUFFIX: '.txt',
NAVIGATION_WITH_KEYS: false NAVIGATION_WITH_KEYS: false,
SHOW_SEARCH_SUMMARY: true,
ENABLE_SEARCH_SHORTCUTS: true,
}; };
\ No newline at end of file
docs/_build/html/_static/jquery-3.4.1.js deleted 100644 → 0
This source diff could not be displayed because it is too large. You can view the blob instead.
docs/_build/html/_static/jquery.js
This source diff could not be displayed because it is too large. You can view the blob instead.
docs/_build/html/_static/language_data.js
...@@ -5,15 +5,16 @@ ...@@ -5,15 +5,16 @@
* This script contains the language-specific data used by searchtools.js, * This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter. * namely the list of stopwords, stemmer, scorer and splitter.
* *
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details. * :license: BSD, see LICENSE for details.
* *
*/ */
var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"]; var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
/* Non-minified version JS is _stemmer.js if file is provided */ /* Non-minified version is copied as a separate JS file, is available */
/** /**
* Porter Stemmer * Porter Stemmer
*/ */
...@@ -196,102 +197,3 @@ var Stemmer = function() { ...@@ -196,102 +197,3 @@ var Stemmer = function() {
} }
} }
var splitChars = (function() {
var result = {};
var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702,
2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971,
2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345,
3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761,
3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823,
4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125,
8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695,
11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587,
43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141];
var i, j, start, end;
for (i = 0; i < singles.length; i++) {
result[singles[i]] = true;
}
var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709],
[722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161],
[1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568],
[1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807],
[1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047],
[2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383],
[2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450],
[2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547],
[2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673],
[2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820],
[2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946],
[2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023],
[3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173],
[3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332],
[3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481],
[3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718],
[3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791],
[3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095],
[4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205],
[4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687],
[4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968],
[4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869],
[5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102],
[6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271],
[6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592],
[6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822],
[6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167],
[7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959],
[7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143],
[8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318],
[8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483],
[8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101],
[10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567],
[11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292],
[12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444],
[12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783],
[12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311],
[19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511],
[42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774],
[42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071],
[43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263],
[43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519],
[43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647],
[43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967],
[44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295],
[57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274],
[64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007],
[65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381],
[65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]];
for (i = 0; i < ranges.length; i++) {
start = ranges[i][0];
end = ranges[i][1];
for (j = start; j <= end; j++) {
result[j] = true;
}
}
return result;
})();
function splitQuery(query) {
var result = [];
var start = -1;
for (var i = 0; i < query.length; i++) {
if (splitChars[query.charCodeAt(i)]) {
if (start !== -1) {
result.push(query.slice(start, i));
start = -1;
}
} else if (start === -1) {
start = i;
}
}
if (start !== -1) {
result.push(query.slice(start));
}
return result;
}
docs/_build/html/_static/pygments.css
pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc } .highlight .hll { background-color: #ffffcc }
.highlight { background: #f8f8f8; } .highlight { background: #f8f8f8; }
.highlight .c { color: #8f5902; font-style: italic } /* Comment */ .highlight .c { color: #3D7B7B; font-style: italic } /* Comment */
.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */ .highlight .err { border: 1px solid #FF0000 } /* Error */
.highlight .g { color: #000000 } /* Generic */ .highlight .k { color: #008000; font-weight: bold } /* Keyword */
.highlight .k { color: #004461; font-weight: bold } /* Keyword */ .highlight .o { color: #666666 } /* Operator */
.highlight .l { color: #000000 } /* Literal */ .highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */
.highlight .n { color: #000000 } /* Name */ .highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */
.highlight .o { color: #582800 } /* Operator */ .highlight .cp { color: #9C6500 } /* Comment.Preproc */
.highlight .x { color: #000000 } /* Other */ .highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */
.highlight .p { color: #000000; font-weight: bold } /* Punctuation */ .highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */
.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */ .highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */
.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */ .highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .cp { color: #8f5902 } /* Comment.Preproc */ .highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */ .highlight .gr { color: #E40000 } /* Generic.Error */
.highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */
.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */
.highlight .gd { color: #a40000 } /* Generic.Deleted */
.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */
.highlight .gr { color: #ef2929 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */ .highlight .gi { color: #008400 } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */ .highlight .go { color: #717171 } /* Generic.Output */
.highlight .gp { color: #745334 } /* Generic.Prompt */ .highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */ .highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */ .highlight .gt { color: #0044DD } /* Generic.Traceback */
.highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */ .highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */ .highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */ .highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */ .highlight .kp { color: #008000 } /* Keyword.Pseudo */
.highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */ .highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */ .highlight .kt { color: #B00040 } /* Keyword.Type */
.highlight .ld { color: #000000 } /* Literal.Date */ .highlight .m { color: #666666 } /* Literal.Number */
.highlight .m { color: #990000 } /* Literal.Number */ .highlight .s { color: #BA2121 } /* Literal.String */
.highlight .s { color: #4e9a06 } /* Literal.String */ .highlight .na { color: #687822 } /* Name.Attribute */
.highlight .na { color: #c4a000 } /* Name.Attribute */ .highlight .nb { color: #008000 } /* Name.Builtin */
.highlight .nb { color: #004461 } /* Name.Builtin */ .highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
.highlight .nc { color: #000000 } /* Name.Class */ .highlight .no { color: #880000 } /* Name.Constant */
.highlight .no { color: #000000 } /* Name.Constant */ .highlight .nd { color: #AA22FF } /* Name.Decorator */
.highlight .nd { color: #888888 } /* Name.Decorator */ .highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */
.highlight .ni { color: #ce5c00 } /* Name.Entity */ .highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */
.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */ .highlight .nf { color: #0000FF } /* Name.Function */
.highlight .nf { color: #000000 } /* Name.Function */ .highlight .nl { color: #767600 } /* Name.Label */
.highlight .nl { color: #f57900 } /* Name.Label */ .highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
.highlight .nn { color: #000000 } /* Name.Namespace */ .highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
.highlight .nx { color: #000000 } /* Name.Other */ .highlight .nv { color: #19177C } /* Name.Variable */
.highlight .py { color: #000000 } /* Name.Property */ .highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
.highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */ .highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .nv { color: #000000 } /* Name.Variable */ .highlight .mb { color: #666666 } /* Literal.Number.Bin */
.highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */ .highlight .mf { color: #666666 } /* Literal.Number.Float */
.highlight .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */ .highlight .mh { color: #666666 } /* Literal.Number.Hex */
.highlight .mb { color: #990000 } /* Literal.Number.Bin */ .highlight .mi { color: #666666 } /* Literal.Number.Integer */
.highlight .mf { color: #990000 } /* Literal.Number.Float */ .highlight .mo { color: #666666 } /* Literal.Number.Oct */
.highlight .mh { color: #990000 } /* Literal.Number.Hex */ .highlight .sa { color: #BA2121 } /* Literal.String.Affix */
.highlight .mi { color: #990000 } /* Literal.Number.Integer */ .highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
.highlight .mo { color: #990000 } /* Literal.Number.Oct */ .highlight .sc { color: #BA2121 } /* Literal.String.Char */
.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */ .highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */
.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */ .highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
.highlight .sc { color: #4e9a06 } /* Literal.String.Char */ .highlight .s2 { color: #BA2121 } /* Literal.String.Double */
.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */ .highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */
.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */ .highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */
.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */ .highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */
.highlight .se { color: #4e9a06 } /* Literal.String.Escape */ .highlight .sx { color: #008000 } /* Literal.String.Other */
.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */ .highlight .sr { color: #A45A77 } /* Literal.String.Regex */
.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */ .highlight .s1 { color: #BA2121 } /* Literal.String.Single */
.highlight .sx { color: #4e9a06 } /* Literal.String.Other */ .highlight .ss { color: #19177C } /* Literal.String.Symbol */
.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */ .highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */ .highlight .fm { color: #0000FF } /* Name.Function.Magic */
.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */ .highlight .vc { color: #19177C } /* Name.Variable.Class */
.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */ .highlight .vg { color: #19177C } /* Name.Variable.Global */
.highlight .fm { color: #000000 } /* Name.Function.Magic */ .highlight .vi { color: #19177C } /* Name.Variable.Instance */
.highlight .vc { color: #000000 } /* Name.Variable.Class */ .highlight .vm { color: #19177C } /* Name.Variable.Magic */
.highlight .vg { color: #000000 } /* Name.Variable.Global */ .highlight .il { color: #666666 } /* Literal.Number.Integer.Long */
.highlight .vi { color: #000000 } /* Name.Variable.Instance */ \ No newline at end of file
.highlight .vm { color: #000000 } /* Name.Variable.Magic */
.highlight .il { color: #990000 } /* Literal.Number.Integer.Long */
\ No newline at end of file
docs/_build/html/_static/sphinx_highlight.js 0 → 100644
/* Highlighting utilities for Sphinx HTML documentation. */
"use strict";
const SPHINX_HIGHLIGHT_ENABLED = true
/**
* highlight a given string on a node by wrapping it in
* span elements with the given class name.
*/
const _highlight = (node, addItems, text, className) => {
if (node.nodeType === Node.TEXT_NODE) {
const val = node.nodeValue;
const parent = node.parentNode;
const pos = val.toLowerCase().indexOf(text);
if (
pos >= 0 &&
!parent.classList.contains(className) &&
!parent.classList.contains("nohighlight")
) {
let span;
const closestNode = parent.closest("body, svg, foreignObject");
const isInSVG = closestNode && closestNode.matches("svg");
if (isInSVG) {
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
} else {
span = document.createElement("span");
span.classList.add(className);
}
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
parent.insertBefore(
span,
parent.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling
)
);
node.nodeValue = val.substr(0, pos);
if (isInSVG) {
const rect = document.createElementNS(
"http://www.w3.org/2000/svg",
"rect"
);
const bbox = parent.getBBox();
rect.x.baseVal.value = bbox.x;
rect.y.baseVal.value = bbox.y;
rect.width.baseVal.value = bbox.width;
rect.height.baseVal.value = bbox.height;
rect.setAttribute("class", className);
addItems.push({ parent: parent, target: rect });
}
}
} else if (node.matches && !node.matches("button, select, textarea")) {
node.childNodes.forEach((el) => _highlight(el, addItems, text, className));
}
};
const _highlightText = (thisNode, text, className) => {
let addItems = [];
_highlight(thisNode, addItems, text, className);
addItems.forEach((obj) =>
obj.parent.insertAdjacentElement("beforebegin", obj.target)
);
};
/**
* Small JavaScript module for the documentation.
*/
const SphinxHighlight = {
/**
* highlight the search words provided in localstorage in the text
*/
highlightSearchWords: () => {
if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight
// get and clear terms from localstorage
const url = new URL(window.location);
const highlight =
localStorage.getItem("sphinx_highlight_terms")
|| url.searchParams.get("highlight")
|| "";
localStorage.removeItem("sphinx_highlight_terms")
url.searchParams.delete("highlight");
window.history.replaceState({}, "", url);
// get individual terms from highlight string
const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);
if (terms.length === 0) return; // nothing to do
// There should never be more than one element matching "div.body"
const divBody = document.querySelectorAll("div.body");
const body = divBody.length ? divBody[0] : document.querySelector("body");
window.setTimeout(() => {
terms.forEach((term) => _highlightText(body, term, "highlighted"));
}, 10);
const searchBox = document.getElementById("searchbox");
if (searchBox === null) return;
searchBox.appendChild(
document
.createRange()
.createContextualFragment(
'<p class="highlight-link">' +
'<a href="javascript:SphinxHighlight.hideSearchWords()">' +
_("Hide Search Matches") +
"</a></p>"
)
);
},
/**
* helper function to hide the search marks again
*/
hideSearchWords: () => {
document
.querySelectorAll("#searchbox .highlight-link")
.forEach((el) => el.remove());
document
.querySelectorAll("span.highlighted")
.forEach((el) => el.classList.remove("highlighted"));
localStorage.removeItem("sphinx_highlight_terms")
},
initEscapeListener: () => {
// only install a listener if it is really needed
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return;
document.addEventListener("keydown", (event) => {
// bail for input elements
if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
// bail with special keys
if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return;
if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) {
SphinxHighlight.hideSearchWords();
event.preventDefault();
}
});
},
};
_ready(SphinxHighlight.highlightSearchWords);
_ready(SphinxHighlight.initEscapeListener);
docs/_build/analysis.html → docs/_build/html/analysis.html
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <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" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Analyzing the ESGEMME output &mdash; esgemme 1.3.0 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <title>Analyzing the ESGEMME output &mdash; esgemme 1.3.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <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]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script> <script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script> <script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="Preparing Your Own Input" href="input-preparation.html" />
<link rel="prev" title="Using ESGEMME via Docker" href="docker.html" /> <link rel="prev" title="Using ESGEMME via Docker" href="docker.html" />
</head> </head>
...@@ -38,10 +42,12 @@ ...@@ -38,10 +42,12 @@
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Contents:</span></p> <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using ESGEMME via Docker</a></li> <li class="toctree-l1"><a class="reference internal" href="docker.html">Using ESGEMME via Docker</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Analyzing the ESGEMME output</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Analyzing the ESGEMME 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="installation.html">Installation</a></li>
</ul> </ul>
</div> </div>
...@@ -68,8 +74,8 @@ ...@@ -68,8 +74,8 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<div class="section" id="analyzing-the-esgemme-output"> <section id="analyzing-the-esgemme-output">
<h1>Analyzing the ESGEMME output<a class="headerlink" href="#analyzing-the-esgemme-output" title="Permalink to this headline"></a></h1> <h1>Analyzing the ESGEMME output<a class="headerlink" href="#analyzing-the-esgemme-output" title="Permalink to this heading"></a></h1>
<p>By default, ESGEMME will output the following files: * <p>By default, ESGEMME will output the following files: *
myProt_normPred_evolEpi.txt * myProt_normPred_evolInd.txt * myProt_normPred_evolEpi.txt * myProt_normPred_evolInd.txt *
myProt_normPred_evolCombi.txt</p> myProt_normPred_evolCombi.txt</p>
...@@ -80,13 +86,14 @@ query sequence. If the user provides her/his own list of mutations, then ...@@ -80,13 +86,14 @@ query sequence. If the user provides her/his own list of mutations, then
only the global epistatic model will be run and the output file will only the global epistatic model will be run and the output file will
contain 2 columns, the first one with the mutations, the second one with contain 2 columns, the first one with the mutations, the second one with
the normalized predicted effects.</p> the normalized predicted effects.</p>
</div> </section>
</div> </div>
</div> </div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="docker.html" class="btn btn-neutral float-left" title="Using ESGEMME via Docker" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <a href="docker.html" class="btn btn-neutral float-left" title="Using ESGEMME via Docker" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="input-preparation.html" class="btn btn-neutral float-right" title="Preparing Your Own Input" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div> </div>
<hr/> <hr/>
......
docs/_build/html/genindex.html
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html xmlns="http://www.w3.org/1999/xhtml"> <head>
<head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<title>Index &#8212; esgemme 1.3.0 documentation</title> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> <title>Index &mdash; esgemme 1.3.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script> <script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="#" /> <link rel="index" title="Index" href="#" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
</head>
<link rel="stylesheet" href="_static/custom.css" type="text/css" /> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> <div class="wy-side-scroll">
<div class="wy-side-nav-search" >
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1 id="index">Index</h1>
<div class="genindex-jumpbox">
<a href="index.html" class="icon icon-home">
esgemme
</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><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>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">esgemme</a></h1>
<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using ESGEMME via Docker</a></li> <li class="toctree-l1"><a class="reference internal" href="docker.html">Using ESGEMME via Docker</a></li>
<li class="toctree-l1"><a class="reference internal" href="analysis.html">Analyzing the ESGEMME 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="installation.html">Installation</a></li>
</ul> </ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div> </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">esgemme</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">Index</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div> </div>
<script>$('#searchbox').show(0);</script> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1 id="index">Index</h1>
<div class="genindex-jumpbox">
</div>
</div> </div>
</div> </div>
<div class="clearer"></div> <footer>
</div>
<div class="footer">
&copy;2023, Mustafa Tekpinar.
| <hr/>
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
<div role="contentinfo">
<p>&#169; Copyright 2023, Mustafa Tekpinar.</p>
</div> </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> </body>
</html> </html>
\ No newline at end of file
docs/_build/html/index.html
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<html xmlns="http://www.w3.org/1999/xhtml"> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<head> <title>Welcome to esgemme’s documentation! &mdash; esgemme 1.3.0 documentation</title>
<meta charset="utf-8" />
<title>Welcome to esgemme’s documentation! &#8212; esgemme 1.3.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script> <script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="Using ESGEMME via Docker" href="docker.html" /> <link rel="next" title="Using ESGEMME via Docker" href="docker.html" />
</head>
<link rel="stylesheet" href="_static/custom.css" type="text/css" /> <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" >
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<a href="#" class="icon icon-home">
esgemme
</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>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using ESGEMME via Docker</a></li>
<li class="toctree-l1"><a class="reference internal" href="analysis.html">Analyzing the ESGEMME 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="installation.html">Installation</a></li>
</ul>
<div class="body" role="main"> </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="#">esgemme</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="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Welcome to esgemme’s documentation!</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="welcome-to-esgemme-s-documentation"> <section id="welcome-to-esgemme-s-documentation">
<h1>Welcome to esgemme’s documentation!<a class="headerlink" href="#welcome-to-esgemme-s-documentation" title="Permalink to this headline"></a></h1> <h1>Welcome to esgemme’s documentation!<a class="headerlink" href="#welcome-to-esgemme-s-documentation" title="Permalink to this heading"></a></h1>
<div class="toctree-wrapper compound"> <div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Contents:</span></p> <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using ESGEMME via Docker</a><ul> <li class="toctree-l1"><a class="reference internal" href="docker.html">Using ESGEMME via Docker</a><ul>
<li class="toctree-l2"><a class="reference internal" href="docker.html#requirements">Requirements</a></li> <li class="toctree-l2"><a class="reference internal" href="docker.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="docker.html#getting-the-input-data">Getting the input data</a></li> <li class="toctree-l2"><a class="reference internal" href="docker.html#getting-the-example-input-data">Getting the example input data</a></li>
<li class="toctree-l2"><a class="reference internal" href="docker.html#running-a-calculation-for-a-single-sequence-protein">Running a calculation for a single sequence/protein</a></li> <li class="toctree-l2"><a class="reference internal" href="docker.html#single-point-mutation-calculations">Single point mutation calculations</a></li>
<li class="toctree-l2"><a class="reference internal" href="docker.html#multiple-point-mutation-calculations">Multiple point mutation calculations</a></li>
<li class="toctree-l2"><a class="reference internal" href="docker.html#running-several-jobs-using-docker">Running several jobs using docker</a></li> <li class="toctree-l2"><a class="reference internal" href="docker.html#running-several-jobs-using-docker">Running several jobs using docker</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="analysis.html">Analyzing the ESGEMME output</a></li>
<li class="toctree-l1"><a class="reference internal" href="input-preparation.html">Preparing Your Own Input</a><ul>
<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="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#getting-the-source-code-and-preparing-the-environment">Getting the source code and preparing the environment:</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#configuring-default-conf-file">Configuring default.conf file</a></li>
</ul>
</li>
</ul> </ul>
</div> </div>
</div> </section>
<div class="section" id="indices-and-tables"> <section id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1> <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this heading"></a></h1>
<ul class="simple"> <ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li> <li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li> <li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li> <li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul> </ul>
</div> </section>
</div> </div>
</div> </div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="docker.html" class="btn btn-neutral float-right" title="Using ESGEMME via Docker" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div> </div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="#">esgemme</a></h1>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023, Mustafa Tekpinar.</p>
<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using ESGEMME via Docker</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="#">Documentation overview</a><ul>
<li>Next: <a href="docker.html" title="next chapter">Using ESGEMME via Docker</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div> </div>
</div>
<script>$('#searchbox').show(0);</script>
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>
</div> </div>
<div class="clearer"></div> </section>
</div> </div>
<div class="footer"> <script>
&copy;2023, Mustafa Tekpinar. jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
| });
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.0</a> </script>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="_sources/index.rst.txt"
rel="nofollow">Page source</a>
</div>
</body> </body>
</html> </html>
\ No newline at end of file
docs/_build/genindex.html → docs/_build/html/input-preparation.html
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <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" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &mdash; esgemme 1.3.0 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <title>Preparing Your Own Input &mdash; esgemme 1.3.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <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]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script> <script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script> <script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="#" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="Installation" href="installation.html" />
<link rel="prev" title="Analyzing the ESGEMME output" href="analysis.html" />
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
...@@ -38,10 +42,14 @@ ...@@ -38,10 +42,14 @@
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Contents:</span></p> <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using ESGEMME via Docker</a></li> <li class="toctree-l1"><a class="reference internal" href="docker.html">Using ESGEMME via Docker</a></li>
<li class="toctree-l1"><a class="reference internal" href="analysis.html">Analyzing the ESGEMME output</a></li> <li class="toctree-l1"><a class="reference internal" href="analysis.html">Analyzing the ESGEMME output</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Preparing Your Own Input</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#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="installation.html">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
</ul> </ul>
...@@ -59,8 +67,9 @@ ...@@ -59,8 +67,9 @@
<div role="navigation" aria-label="Page navigation"> <div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Index</li> <li class="breadcrumb-item active">Preparing Your Own Input</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
<a href="_sources/input-preparation.rst.txt" rel="nofollow"> View page source</a>
</li> </li>
</ul> </ul>
<hr/> <hr/>
...@@ -68,17 +77,73 @@ ...@@ -68,17 +77,73 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<section id="preparing-your-own-input">
<h1 id="index">Index</h1> <h1>Preparing Your Own Input<a class="headerlink" href="#preparing-your-own-input" title="Permalink to this heading"></a></h1>
<section id="preparing-your-input-msa-and-pdb-with-colabfold">
<div class="genindex-jumpbox"> <h2>Preparing Your Input MSA and PDB with Colabfold<a class="headerlink" href="#preparing-your-input-msa-and-pdb-with-colabfold" title="Permalink to this heading"></a></h2>
<p>You have a fasta file for your protein of interest and you want to understand
impact of (certain) mutations.
Before starting, please make sure that your fasta file does not contain a gap.
The quickest method to obtain both multiple sequence alignment and a protein
structure is to use Colabfold. Let’s do this step by step:</p>
<ol class="arabic">
<li><p>Let’s go the Colabfold web site:</p>
<p><a class="reference external" href="https://colab.research.google.com/github/sokrypton/ColabFold/blob/main/AlphaFold2.ipynb">https://colab.research.google.com/github/sokrypton/ColabFold/blob/main/AlphaFold2.ipynb</a></p>
<p>Sign in using your gmail account.</p>
</li>
<li><p>Click on the ‘Connect’ button on the top right hand side.</p></li>
<li><p>Clean ‘query_sequence’ box and paste your sequence to the ‘query_sequence’ box.
For me, I selected adenylate kinase (AKE) as my example fasta sequence
(<a class="reference external" href="https://www.rcsb.org/fasta/entry/4AKE/display">https://www.rcsb.org/fasta/entry/4AKE/display</a>).</p></li>
<li><p>Change the ‘jobname’ to something that makes more sense to you.</p></li>
<li><p>Go to the menu bar of your ‘AlphaFold2.ipynb’ notebook, where ‘File, Edit,
View, Insert, Runtime, Tools, Help’ are listed. Click on the Runtime and
select ‘Run all’.</p></li>
<li><p>This process make take from a few minutes to a few hours depending on your
protein size. It will give you an a3m file and up to 5 PDB models. Put these
files in a clean folder and change the directory to that folder in your
terminal.</p></li>
<li><p>Unfortunately, a3m file is not in fasta format and it contains gap columns.
We have to clean those gaps. We can do that with a GUI program like Ugene
or Jalview. However, it is a labor intensive procedure. Here, I will use a
small tool that I developed and added to the ESGEMME docker image that I created.</p></li>
<li><p>Start the docker image with the following command:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>docker<span class="w"> </span>run<span class="w"> </span>-ti<span class="w"> </span>--rm<span class="w"> </span>--mount<span class="w"> </span><span class="nv">type</span><span class="o">=</span>bind,source<span class="o">=</span><span class="nv">$PWD</span>,target<span class="o">=</span>/home/tekpinar/research/myexample<span class="w"> </span><span class="se">\</span>
tekpinar/esgemme-docker:v1.3.0
</pre></div>
</div>
</li>
<li><p>Now, change the directory to myexample folder.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>../myexample/
ls<span class="w"> </span>-l
</pre></div>
</div>
<p>We are supposed to see our a3m and pdb files in this folder.</p>
</li>
<li><p>Let’s use a small script from hhsuite to convert a3m file to fasta format.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>reformat.pl<span class="w"> </span>a3m<span class="w"> </span>fas<span class="w"> </span>AKE.a3m<span class="w"> </span>AKE.fasta
</pre></div>
</div> </div>
</li>
<li><p>Final step and we are there:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>demust<span class="w"> </span>removegaps<span class="w"> </span>-i<span class="w"> </span>AKE.fasta<span class="w"> </span>-o<span class="w"> </span>AKE_nogaps.fasta
</pre></div>
</div>
</li>
</ol>
<p>Congratulations! Now, you have all the input files required for ESGEMME:
I. An input MSA: AKE_nogaps.fasta
II. An input PDB: myprotein.pdb</p>
</section>
</section>
</div> </div>
</div> </div>
<footer> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="analysis.html" class="btn btn-neutral float-left" title="Analyzing the ESGEMME output" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="installation.html" class="btn btn-neutral float-right" title="Installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/> <hr/>
......
docs/_build/installation.html → docs/_build/html/installation.html
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <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" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Installation &mdash; esgemme 1.3.0 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <title>Installation &mdash; esgemme 1.3.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <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]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script> <script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script> <script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="prev" title="Analyzing the ESGEMME output" href="analysis.html" /> <link rel="prev" title="Preparing Your Own Input" href="input-preparation.html" />
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
...@@ -38,10 +41,11 @@ ...@@ -38,10 +41,11 @@
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Contents:</span></p> <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using ESGEMME via Docker</a></li> <li class="toctree-l1"><a class="reference internal" href="docker.html">Using ESGEMME via Docker</a></li>
<li class="toctree-l1"><a class="reference internal" href="analysis.html">Analyzing the ESGEMME output</a></li> <li class="toctree-l1"><a class="reference internal" href="analysis.html">Analyzing the ESGEMME 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-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> <li class="toctree-l2"><a class="reference internal" href="#installing-the-dependencies">Installing the dependencies:</a></li>
<li class="toctree-l2"><a class="reference internal" href="#getting-the-source-code-and-preparing-the-environment">Getting the source code and preparing the environment:</a></li> <li class="toctree-l2"><a class="reference internal" href="#getting-the-source-code-and-preparing-the-environment">Getting the source code and preparing the environment:</a></li>
...@@ -74,45 +78,51 @@ ...@@ -74,45 +78,51 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<div class="section" id="installation"> <section id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h1> <h1>Installation<a class="headerlink" href="#installation" title="Permalink to this heading"></a></h1>
<p>ESGEMME is implemented in Python 3 and R. It has been tested only on <p>ESGEMME is implemented in Python 3 and R. It has been tested only on
Linux. Since ESGEMME has many dependencies, we recommend using our web Linux. Since ESGEMME has many dependencies, we recommend using our web
site or our docker image. If you are a determined user, here comes the site or our docker image. If you are a determined user, here comes the
steps required to install it from the source.</p> steps required to install it from the source.</p>
<div class="section" id="installing-the-dependencies"> <section id="installing-the-dependencies">
<h2>Installing the dependencies:<a class="headerlink" href="#installing-the-dependencies" title="Permalink to this headline"></a></h2> <h2>Installing the dependencies:<a class="headerlink" href="#installing-the-dependencies" title="Permalink to this heading"></a></h2>
<p>ESGEMME has the following external dependencies: * Joint Evolutionary <p>ESGEMME has the following external dependencies:</p>
Trees: <a class="reference external" href="http://www.lcqb.upmc.fr/JET2/">http://www.lcqb.upmc.fr/JET2/</a> and its dependencies: - naccess: <ul class="simple">
<a class="reference external" href="http://www.bioinf.manchester.ac.uk/naccess/">http://www.bioinf.manchester.ac.uk/naccess/</a> - muscle: <li><p>Joint Evolutionary Trees: <a class="reference external" href="http://www.lcqb.upmc.fr/JET2/">http://www.lcqb.upmc.fr/JET2/</a> and its dependencies:</p>
<a class="reference external" href="https://www.drive5.com/muscle/">https://www.drive5.com/muscle/</a> ** * seqinr R package: <ul>
<a class="reference external" href="https://cran.r-project.org/web/packages/seqinr/index.html">https://cran.r-project.org/web/packages/seqinr/index.html</a> * dssp for <li><p>java</p></li>
secondary structure prediction.</p> <li><p>naccess: <a class="reference external" href="http://www.bioinf.manchester.ac.uk/naccess/">http://www.bioinf.manchester.ac.uk/naccess/</a></p></li>
<li><p>muscle: <a class="reference external" href="https://www.drive5.com/muscle/">https://www.drive5.com/muscle/</a></p></li>
</ul>
</li>
<li><p>seqinr R package: <a class="reference external" href="https://cran.r-project.org/web/packages/seqinr/index.html">https://cran.r-project.org/web/packages/seqinr/index.html</a></p></li>
<li><p>dssp for secondary structure prediction.</p></li>
</ul>
<p>These tools should be installed to be able to use ESGEMME.</p> <p>These tools should be installed to be able to use ESGEMME.</p>
</div> </section>
<div class="section" id="getting-the-source-code-and-preparing-the-environment"> <section id="getting-the-source-code-and-preparing-the-environment">
<h2>Getting the source code and preparing the environment:<a class="headerlink" href="#getting-the-source-code-and-preparing-the-environment" title="Permalink to this headline"></a></h2> <h2>Getting the source code and preparing the environment:<a class="headerlink" href="#getting-the-source-code-and-preparing-the-environment" title="Permalink to this heading"></a></h2>
<p>Download the ESGEMME source code from <p>Download the ESGEMME source code from
<a class="reference external" href="http://gitlab.lcqb.upmc.fr/tekpinar/ESGEMME">http://gitlab.lcqb.upmc.fr/tekpinar/ESGEMME</a>. Define and export the <a class="reference external" href="http://gitlab.lcqb.upmc.fr/tekpinar/ESGEMME">http://gitlab.lcqb.upmc.fr/tekpinar/ESGEMME</a>. Define and export the
environment variable ESGEMME_PATH=/path-to-ESGEMME-directory/</p> environment variable ESGEMME_PATH=/path-to-ESGEMME-directory/</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span> <span class="nv">ESGEMME_PATH</span><span class="o">=</span>/path-to-ESGEMME-directory/ <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">ESGEMME_PATH</span><span class="o">=</span>/path-to-ESGEMME-directory/
</pre></div> </pre></div>
</div> </div>
</div> </section>
<div class="section" id="configuring-default-conf-file"> <section id="configuring-default-conf-file">
<h2>Configuring default.conf file<a class="headerlink" href="#configuring-default-conf-file" title="Permalink to this headline"></a></h2> <h2>Configuring default.conf file<a class="headerlink" href="#configuring-default-conf-file" title="Permalink to this heading"></a></h2>
<p>Inside ESGEMME folder, there is an important file called default.conf. <p>Inside ESGEMME folder, there is an important file called default.conf.
This file contains essential parameters of ESGEMME, such as paths of This file contains essential parameters of ESGEMME, such as paths of
external parts, default internal parameters. etc. You have to correct the Software section of this external parts, default internal parameters. etc. You have to correct the Software section of this
file according to your system.</p> file according to your system.</p>
</div> </section>
</div> </section>
</div> </div>
</div> </div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="analysis.html" class="btn btn-neutral float-left" title="Analyzing the ESGEMME output" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <a href="input-preparation.html" class="btn btn-neutral float-left" title="Preparing Your Own Input" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> </div>
<hr/> <hr/>
......
docs/_build/html/search.html
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html xmlns="http://www.w3.org/1999/xhtml"> <head>
<head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<title>Search &#8212; esgemme 1.3.0 documentation</title> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> <title>Search &mdash; esgemme 1.3.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <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]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script> <script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<script src="_static/searchtools.js"></script> <script src="_static/searchtools.js"></script>
<script src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="#" /> <link rel="search" title="Search" href="#" />
<script src="searchindex.js" defer></script> </head>
<link rel="stylesheet" href="_static/custom.css" type="text/css" /> <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" >
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<a href="index.html" class="icon icon-home">
esgemme
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="#" 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>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using ESGEMME via Docker</a></li>
<li class="toctree-l1"><a class="reference internal" href="analysis.html">Analyzing the ESGEMME 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="installation.html">Installation</a></li>
</ul>
<div class="body" role="main"> </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">esgemme</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">Search</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">
<h1 id="search-documentation">Search</h1> <noscript>
<div id="fallback" class="admonition warning"> <div id="fallback" class="admonition warning">
<script>$('#fallback').hide();</script> <p class="last">
<p> Please activate JavaScript to enable the search functionality.
Please activate JavaScript to enable the search
functionality.
</p> </p>
</div> </div>
<p> </noscript>
From here you can search these documents. Enter your search
words into the box below and click "search". Note that the search
function will automatically search for all of the words. Pages
containing fewer words won't appear in the result list.
</p>
<form action="" method="get">
<input type="text" name="q" aria-labelledby="search-documentation" value="" />
<input type="submit" value="search" />
<span id="search-progress" style="padding-left: 10px"></span>
</form>
<div id="search-results">
</div> <div id="search-results">
</div> </div>
</div> </div>
</div> </div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <footer>
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">esgemme</a></h1>
<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using ESGEMME via Docker</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023, Mustafa Tekpinar.</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>
</div> </div>
<div class="clearer"></div> </section>
</div>
<div class="footer">
&copy;2023, Mustafa Tekpinar.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
</div> </div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<script>
jQuery(function() { Search.loadIndex("searchindex.js"); });
</script>
<script id="searchindexloader"></script>
</body> </body>
</html> </html>
\ No newline at end of file
docs/_build/html/searchindex.js
Search.setIndex({docnames:["docker","index"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.index":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:56},filenames:["docker.rst","index.rst"],objects:{},objnames:{},objtypes:{},terms:{"try":0,One:0,Using:1,af2:0,after:0,aliblat:0,align:0,all:0,app:0,assum:0,basic:0,befor:0,bind:0,blat:0,blat_normpred_evolcombi:0,blob:0,calcul:1,call:0,can:0,chang:0,check:0,com:0,command:0,consult:0,contain:0,content:1,creat:0,curl:0,data:1,databank:0,doc:0,docker:1,don:0,done:0,download:0,empti:0,entir:0,esgemme_path:0,exercis:0,familiar:0,fasta:0,favorit:0,few:0,file:0,first:0,folder:0,follow:0,format:0,get:1,gitlab:0,good:0,have:0,home:0,host:0,http:0,index:1,input:1,instal:0,job:1,landscap:0,last:0,lcqb:0,let:0,linux:0,list:0,machin:0,maco:0,mai:0,make:0,master:0,minut:0,mkdir:0,modul:1,mount:0,multipl:0,must:0,mutat:0,myexampl:0,name:0,need:0,now:0,oper:0,option:0,order:0,our:0,page:[0,1],pdb:0,pdbfile:0,place:0,pleas:0,png:0,point:0,previou:0,protein:1,provid:0,pwd:0,python:0,repositori:0,requir:1,research:0,run:1,same:0,sampl:0,search:1,see:0,sequenc:1,sever:1,show:0,singl:1,some:0,sourc:0,start:0,step:0,sudo:0,suppos:0,sure:0,system:0,target:0,tekpinar:0,termin:0,thi:0,track:0,tutori:0,two:0,txt:0,type:0,unix:0,upmc:0,using:1,verifi:0,via:1,virtual:0,wget:0,when:0,word:0,you:0,your:0},titles:["Using ESGEMME via Docker","Welcome to esgemme\u2019s documentation!"],titleterms:{Using:0,calcul:0,data:0,docker:0,document:1,esgemm:[0,1],get:0,indic:1,input:0,job:0,protein:0,requir:0,run:0,sequenc:0,sever:0,singl:0,tabl:1,using:0,via:0,welcom:1}}) Search.setIndex({"docnames": ["analysis", "docker", "index", "input-preparation", "installation"], "filenames": ["analysis.rst", "docker.rst", "index.rst", "input-preparation.rst", "installation.rst"], "titles": ["Analyzing the ESGEMME output", "Using ESGEMME via Docker", "Welcome to esgemme\u2019s documentation!", "Preparing Your Own Input", "Installation"], "terms": {"By": 0, "default": [0, 2], "follow": [0, 1, 3, 4], "file": [0, 1, 2, 3], "myprot_normpred_evolepi": 0, "txt": [0, 1], "myprot_normpred_evolind": 0, "myprot_normpred_evolcombi": 0, "The": [0, 1, 3], "most": 0, "import": [0, 4], "i": [0, 1, 3, 4], "valu": 0, "interest": [0, 1, 3], "ar": [0, 1, 3, 4], "normal": 0, "predict": [0, 4], "normpr": 0, "each": [0, 1], "contain": [0, 1, 3, 4], "20": 0, "x": 0, "n": 0, "matrix": 0, "where": [0, 3], "number": 0, "posit": 0, "column": [0, 3], "queri": 0, "sequenc": [0, 1, 3], "If": [0, 1, 4], "user": [0, 4], "provid": [0, 1], "her": 0, "hi": 0, "own": [0, 2], "list": [0, 1, 3], "mutat": [0, 2, 3], "onli": [0, 1, 4], "global": 0, "epistat": 0, "model": [0, 3], "run": [0, 2, 3], "2": 0, "first": [0, 1], "one": 0, "second": [0, 1], "effect": 0, "you": [1, 3, 4], "need": 1, "have": [1, 3, 4], "instal": [1, 2], "your": [1, 2, 4], "machin": 1, "can": [1, 3], "consult": 1, "page": [1, 2], "thi": [1, 3, 4], "http": [1, 3, 4], "doc": 1, "com": [1, 3, 4], "am": 1, "assum": 1, "some": 1, "basic": 1, "familiar": 1, "linux": [1, 4], "unix": 1, "maco": 1, "termin": [1, 3], "command": [1, 3], "let": [1, 3], "": [1, 3], "start": [1, 3], "our": [1, 3, 4], "favorit": 1, "app": 1, "must": 1, "creat": [1, 3], "folder": [1, 3, 4], "call": [1, 4], "tutori": 1, "go": [1, 3], "empti": 1, "mkdir": 1, "cd": [1, 3], "download": [1, 4], "sampl": 1, "repositori": 1, "exercis": 1, "we": [1, 3, 4], "align": [1, 3], "fasta": [1, 3], "format": [1, 3], "wget": 1, "gitlab": [1, 4], "lcqb": [1, 4], "upmc": [1, 4], "fr": [1, 4], "tekpinar": [1, 3, 4], "blob": [1, 3], "master": 1, "aliblat": 1, "don": 1, "t": 1, "try": 1, "same": 1, "curl": 1, "pleas": [1, 3], "verifi": 1, "now": [1, 3], "pdb": [1, 2], "protein": [1, 3], "databank": 1, "blat": 1, "af2": 1, "In": 1, "order": 1, "make": [1, 3], "sure": [1, 3], "sudo": [1, 3], "h": 1, "show": 1, "option": 1, "good": 1, "track": 1, "On": 1, "mai": 1, "word": 1, "befor": [1, 3], "all": [1, 3], "ti": [1, 3], "rm": [1, 3], "mount": [1, 3], "type": [1, 3], "bind": [1, 3], "sourc": [1, 2, 3], "pwd": [1, 3], "target": [1, 3], "home": [1, 3], "research": [1, 3], "myexampl": [1, 3], "v1": [1, 3], "3": [1, 3, 4], "0": [1, 3], "virtual": 1, "oper": 1, "system": [1, 4], "previou": 1, "chang": [1, 3], "when": 1, "check": 1, "l": [1, 3], "suppos": [1, 3], "see": [1, 3], "host": 1, "place": 1, "step": [1, 3, 4], "evolutionari": [1, 4], "inform": 1, "from": [1, 3, 4], "an": [1, 3, 4], "msa": [1, 2], "python": [1, 4], "esgemme_path": [1, 4], "py": 1, "r": [1, 4], "f": 1, "after": 1, "few": [1, 3], "minut": [1, 3], "least": 1, "two": 1, "name": 1, "blat_normpred_evolcombi": 1, "png": 1, "want": [1, 3], "util": 1, "structur": [1, 3, 4], "highli": 1, "recommend": [1, 4], "well": 1, "pdbfile": 1, "normweightmod": 1, "sstjetormax": 1, "bunch": 1, "prepar": [1, 2], "mut": 1, "simpl": 1, "text": 1, "line": 1, "d26a": 1, "fortun": 1, "raw": 1, "stiffler_2015_blat_ecolx": 1, "similar": 1, "possibl": 1, "wai": 1, "do": [1, 3], "without": 1, "m": 1, "includ": 1, "code": [1, 2], "bash": 1, "howev": [1, 3], "output": [1, 2], "complet": 1, "differ": 1, "scan": 1, "its": [1, 4], "separ": 1, "space": 1, "addit": 1, "won": 1, "like": [1, 3], "case": 1, "sometim": 1, "doubl": 1, "tripl": 1, "perform": 1, "e26d": 1, "y44r": 1, "e56n": 1, "a77f": 1, "h94v": 1, "impact": [1, 3], "As": 1, "colon": 1, "charact": 1, "us": [2, 3, 4], "via": 2, "docker": [2, 3, 4], "requir": [2, 3, 4], "get": 2, "exampl": [2, 3], "input": 2, "data": 2, "singl": 2, "point": 2, "calcul": 2, "multipl": [2, 3], "sever": 2, "job": 2, "analyz": 2, "colabfold": 2, "depend": [2, 3], "environ": 2, "configur": 2, "conf": 2, "index": [2, 4], "modul": 2, "search": 2, "understand": 3, "certain": 3, "doe": 3, "gap": 3, "quickest": 3, "method": 3, "obtain": 3, "both": 3, "web": [3, 4], "site": [3, 4], "colab": 3, "googl": 3, "github": 3, "sokrypton": 3, "main": 3, "alphafold2": 3, "ipynb": 3, "sign": 3, "gmail": 3, "account": 3, "click": 3, "connect": 3, "button": 3, "top": 3, "right": 3, "hand": 3, "side": 3, "clean": 3, "query_sequ": 3, "box": 3, "past": 3, "For": 3, "me": 3, "select": 3, "adenyl": 3, "kinas": 3, "ak": 3, "my": 3, "www": [3, 4], "rcsb": 3, "org": [3, 4], "entri": 3, "4ake": 3, "displai": 3, "jobnam": 3, "someth": 3, "more": 3, "sens": 3, "menu": 3, "bar": 3, "notebook": 3, "edit": 3, "view": 3, "insert": 3, "runtim": 3, "tool": [3, 4], "help": 3, "process": 3, "take": 3, "hour": 3, "size": 3, "It": [3, 4], "give": 3, "a3m": 3, "up": 3, "5": 3, "put": 3, "directori": [3, 4], "unfortun": 3, "those": 3, "gui": 3, "program": 3, "ugen": 3, "jalview": 3, "labor": 3, "intens": 3, "procedur": 3, "here": [3, 4], "small": 3, "develop": 3, "ad": 3, "esgemm": [3, 4], "imag": [3, 4], "script": 3, "hhsuit": 3, "convert": 3, "reformat": 3, "pl": 3, "fa": 3, "final": 3, "demust": 3, "removegap": 3, "o": 3, "ake_nogap": 3, "congratul": 3, "ii": 3, "myprotein": 3, "implement": 4, "ha": 4, "been": 4, "test": 4, "sinc": 4, "mani": 4, "determin": 4, "come": 4, "extern": 4, "joint": 4, "tree": 4, "jet2": 4, "java": 4, "naccess": 4, "bioinf": 4, "manchest": 4, "ac": 4, "uk": 4, "muscl": 4, "drive5": 4, "seqinr": 4, "packag": 4, "cran": 4, "project": 4, "html": 4, "dssp": 4, "secondari": 4, "These": 4, "should": 4, "abl": 4, "defin": 4, "export": 4, "variabl": 4, "path": 4, "insid": 4, "essenti": 4, "paramet": 4, "part": 4, "intern": 4, "etc": 4, "correct": 4, "softwar": 4, "section": 4, "accord": 4}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"analyz": 0, "esgemm": [0, 1, 2], "output": 0, "us": 1, "via": 1, "docker": 1, "requir": 1, "get": [1, 4], "exampl": 1, "input": [1, 3], "data": 1, "singl": 1, "point": 1, "mutat": 1, "calcul": 1, "obtain": 1, "entir": 1, "landscap": 1, "predict": 1, "effect": 1, "subset": 1, "multipl": 1, "run": 1, "sever": 1, "job": 1, "welcom": 2, "": 2, "document": 2, "content": 2, "indic": 2, "tabl": 2, "prepar": [3, 4], "your": 3, "own": 3, "msa": 3, "pdb": 3, "colabfold": 3, "instal": 4, "depend": 4, "sourc": 4, "code": 4, "environ": 4, "configur": 4, "default": 4, "conf": 4, "file": 4}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"Analyzing the ESGEMME output": [[0, "analyzing-the-esgemme-output"]], "Using ESGEMME via Docker": [[1, "using-esgemme-via-docker"]], "Requirements": [[1, "requirements"]], "Getting the example input data": [[1, "getting-the-example-input-data"]], "Single point mutation calculations": [[1, "single-point-mutation-calculations"]], "Obtaining the entire single point mutation landscape": [[1, "obtaining-the-entire-single-point-mutation-landscape"]], "Predicting the effect of a subset of single point mutations": [[1, "predicting-the-effect-of-a-subset-of-single-point-mutations"]], "Multiple point mutation calculations": [[1, "multiple-point-mutation-calculations"]], "Running several jobs using docker": [[1, "running-several-jobs-using-docker"]], "Welcome to esgemme\u2019s documentation!": [[2, "welcome-to-esgemme-s-documentation"]], "Contents:": [[2, null]], "Indices and tables": [[2, "indices-and-tables"]], "Preparing Your Own Input": [[3, "preparing-your-own-input"]], "Preparing Your Input MSA and PDB with Colabfold": [[3, "preparing-your-input-msa-and-pdb-with-colabfold"]], "Installation": [[4, "installation"]], "Installing the dependencies:": [[4, "installing-the-dependencies"]], "Getting the source code and preparing the environment:": [[4, "getting-the-source-code-and-preparing-the-environment"]], "Configuring default.conf file": [[4, "configuring-default-conf-file"]]}, "indexentries": {}})
\ No newline at end of file \ No newline at end of file
docs/_build/index.html deleted 100644 → 0
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Welcome to esgemme’s documentation! &mdash; esgemme 1.3.0 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.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="Using ESGEMME via Docker" href="docker.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="#" class="icon icon-home">
esgemme
</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"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using ESGEMME via Docker</a></li>
<li class="toctree-l1"><a class="reference internal" href="analysis.html">Analyzing the ESGEMME output</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</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="#">esgemme</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="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Welcome to esgemme’s documentation!</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="welcome-to-esgemme-s-documentation">
<h1>Welcome to esgemme’s documentation!<a class="headerlink" href="#welcome-to-esgemme-s-documentation" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Using ESGEMME via Docker</a><ul>
<li class="toctree-l2"><a class="reference internal" href="docker.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="docker.html#getting-the-input-data">Getting the input data</a></li>
<li class="toctree-l2"><a class="reference internal" href="docker.html#single-point-mutation-calculations">Single point mutation calculations</a></li>
<li class="toctree-l2"><a class="reference internal" href="docker.html#multiple-point-mutation-calculations">Multiple point mutation calculations</a></li>
<li class="toctree-l2"><a class="reference internal" href="docker.html#running-several-jobs-using-docker">Running several jobs using docker</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="analysis.html">Analyzing the ESGEMME output</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#getting-the-source-code-and-preparing-the-environment">Getting the source code and preparing the environment:</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#configuring-default-conf-file">Configuring default.conf file</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</div>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="docker.html" class="btn btn-neutral float-right" title="Using ESGEMME via Docker" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023, Mustafa Tekpinar.</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>
\ No newline at end of file
docs/_build/latex/LICRlatin2utf8.xdy
...@@ -24,7 +24,7 @@ ...@@ -24,7 +24,7 @@
;; covered by original tex/inputenc/utf8.xdy. ;; covered by original tex/inputenc/utf8.xdy.
;; ;;
;; - There is a problem that ȷ is not supported out-of-the box by LaTeX ;; - There is a problem that ȷ is not supported out-of-the box by LaTeX
;; with inputenc, one must add explicitely ;; with inputenc, one must add explicitly
;; \DeclareUnicodeCharacter{0237}{\j} ;; \DeclareUnicodeCharacter{0237}{\j}
;; to preamble of LaTeX document. However this character is not supported ;; to preamble of LaTeX document. However this character is not supported
;; by the TeX "times" font used by default by Sphinx for pdflatex engine. ;; by the TeX "times" font used by default by Sphinx for pdflatex engine.
......
docs/_build/latex/LatinRules.xdy
;; style file for xindy ;; Common Lisp style file for xindy
;; filename: LatinRules.xdy ;; filename: LatinRules.xdy
;; ;;
;; Please note that this data file deliberately uses strings
;; with single non-ascii bytes. This is intentional and
;; follows the usage observed in similar xindy support files.
;;
;; It is based upon xindy's files lang/general/utf8.xdy and ;; It is based upon xindy's files lang/general/utf8.xdy and
;; lang/general/utf8-lang.xdy which implement ;; lang/general/utf8-lang.xdy which implement
;; "a general sorting order for Western European languages" ;; "a general sorting order for Western European languages".
;; ;;
;; The aim for Sphinx is to be able to index in a Cyrillic document ;; The aim for Sphinx is to be able to index in a Cyrillic document
;; also terms using the Latin alphabets, inclusive of letters ;; also terms using the Latin alphabets, inclusive of letters
...@@ -14,7 +18,7 @@ ...@@ -14,7 +18,7 @@
;; ;;
;; So here we use only 0o266 or higher bytes. ;; So here we use only 0o266 or higher bytes.
;; (Ŋ, ŋ, IJ, and ij are absent from ;; (Ŋ, ŋ, IJ, and ij are absent from
;; lang/general/utf8.xdy and not included here) ;; lang/general/utf8.xdy and not included here.)
;; Contributed by the Sphinx team, 2018. ;; Contributed by the Sphinx team, 2018.
(define-letter-group "A" :prefixes ("¶")) (define-letter-group "A" :prefixes ("¶"))
......
docs/_build/latex/Makefile
...@@ -5,7 +5,6 @@ ALLPDF = $(addsuffix .pdf,$(ALLDOCS)) ...@@ -5,7 +5,6 @@ ALLPDF = $(addsuffix .pdf,$(ALLDOCS))
ALLDVI = $(addsuffix .dvi,$(ALLDOCS)) ALLDVI = $(addsuffix .dvi,$(ALLDOCS))
ALLXDV = ALLXDV =
ALLPS = $(addsuffix .ps,$(ALLDOCS)) ALLPS = $(addsuffix .ps,$(ALLDOCS))
ALLIMGS = $(wildcard *.png *.gif *.jpg *.jpeg)
# Prefix for archive names # Prefix for archive names
ARCHIVEPREFIX = ARCHIVEPREFIX =
...@@ -20,9 +19,6 @@ LATEX = latexmk -dvi ...@@ -20,9 +19,6 @@ LATEX = latexmk -dvi
PDFLATEX = latexmk -pdf -dvi- -ps- PDFLATEX = latexmk -pdf -dvi- -ps-
%.png %.gif %.jpg %.jpeg: FORCE_MAKE
extractbb '$@'
%.dvi: %.tex FORCE_MAKE %.dvi: %.tex FORCE_MAKE
$(LATEX) $(LATEXMKOPTS) '$<' $(LATEX) $(LATEXMKOPTS) '$<'
......
docs/_build/latex/_static/_sphinx_javascript_frameworks_compat.js 0 → 100644
/* Compatability shim for jQuery and underscores.js.
*
* Copyright Sphinx contributors
* Released under the two clause BSD licence
*/
/**
* small helper function to urldecode strings
*
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
*/
jQuery.urldecode = function(x) {
if (!x) {
return x
}
return decodeURIComponent(x.replace(/\+/g, ' '));
};
/**
* small helper function to urlencode strings
*/
jQuery.urlencode = encodeURIComponent;
/**
* This function returns the parsed url parameters of the
* current request. Multiple values per key are supported,
* it will always return arrays of strings for the value parts.
*/
jQuery.getQueryParameters = function(s) {
if (typeof s === 'undefined')
s = document.location.search;
var parts = s.substr(s.indexOf('?') + 1).split('&');
var result = {};
for (var i = 0; i < parts.length; i++) {
var tmp = parts[i].split('=', 2);
var key = jQuery.urldecode(tmp[0]);
var value = jQuery.urldecode(tmp[1]);
if (key in result)
result[key].push(value);
else
result[key] = [value];
}
return result;
};
/**
* highlight a given string on a jquery object by wrapping it in
* span elements with the given class name.
*/
jQuery.fn.highlightText = function(text, className) {
function highlight(node, addItems) {
if (node.nodeType === 3) {
var val = node.nodeValue;
var pos = val.toLowerCase().indexOf(text);
if (pos >= 0 &&
!jQuery(node.parentNode).hasClass(className) &&
!jQuery(node.parentNode).hasClass("nohighlight")) {
var span;
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
if (isInSVG) {
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
} else {
span = document.createElement("span");
span.className = className;
}
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling));
node.nodeValue = val.substr(0, pos);
if (isInSVG) {
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
var bbox = node.parentElement.getBBox();
rect.x.baseVal.value = bbox.x;
rect.y.baseVal.value = bbox.y;
rect.width.baseVal.value = bbox.width;
rect.height.baseVal.value = bbox.height;
rect.setAttribute('class', className);
addItems.push({
"parent": node.parentNode,
"target": rect});
}
}
}
else if (!jQuery(node).is("button, select, textarea")) {
jQuery.each(node.childNodes, function() {
highlight(this, addItems);
});
}
}
var addItems = [];
var result = this.each(function() {
highlight(this, addItems);
});
for (var i = 0; i < addItems.length; ++i) {
jQuery(addItems[i].parent).before(addItems[i].target);
}
return result;
};
/*
* backward compatibility for jQuery.browser
* This will be supported until firefox bug is fixed.
*/
if (!jQuery.browser) {
jQuery.uaMatch = function(ua) {
ua = ua.toLowerCase();
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
/(msie) ([\w.]+)/.exec(ua) ||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
[];
return {
browser: match[ 1 ] || "",
version: match[ 2 ] || "0"
};
};
jQuery.browser = {};
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
}
docs/_build/latex/esgemme.aux 0 → 100644
\relax
\providecommand\hyper@newdestlabel[2]{}
\@nameuse{bbl@beforestart}
\providecommand\HyperFirstAtBeginDocument{\AtBeginDocument}
\HyperFirstAtBeginDocument{\ifx\hyper@anchor\@undefined
\global\let\oldcontentsline\contentsline
\gdef\contentsline#1#2#3#4{\oldcontentsline{#1}{#2}{#3}}
\global\let\oldnewlabel\newlabel
\gdef\newlabel#1#2{\newlabelxx{#1}#2}
\gdef\newlabelxx#1#2#3#4#5#6{\oldnewlabel{#1}{{#2}{#3}}}
\AtEndDocument{\ifx\hyper@anchor\@undefined
\let\contentsline\oldcontentsline
\let\newlabel\oldnewlabel
\fi}
\fi}
\global\let\hyper@last\relax
\gdef\HyperFirstAtBeginDocument#1{#1}
\providecommand\HyField@AuxAddToFields[1]{}
\providecommand\HyField@AuxAddToCoFields[2]{}
\babel@aux{english}{}
\newlabel{index::doc}{{}{1}{}{section*.2}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {1}Using ESGEMME via Docker}{1}{chapter.1}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\newlabel{docker:using-esgemme-via-docker}{{1}{1}{Using ESGEMME via Docker}{chapter.1}{}}
\newlabel{docker::doc}{{1}{1}{Using ESGEMME via Docker}{chapter.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {1.1}Requirements}{1}{section.1.1}\protected@file@percent }
\newlabel{docker:requirements}{{1.1}{1}{Requirements}{section.1.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {1.2}Getting the example input data}{1}{section.1.2}\protected@file@percent }
\newlabel{docker:getting-the-example-input-data}{{1.2}{1}{Getting the example input data}{section.1.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {1.3}Single point mutation calculations}{2}{section.1.3}\protected@file@percent }
\newlabel{docker:single-point-mutation-calculations}{{1.3}{2}{Single point mutation calculations}{section.1.3}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {1.3.1}Obtaining the entire single point mutation landscape}{2}{subsection.1.3.1}\protected@file@percent }
\newlabel{docker:obtaining-the-entire-single-point-mutation-landscape}{{1.3.1}{2}{Obtaining the entire single point mutation landscape}{subsection.1.3.1}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {1.3.2}Predicting the effect of a subset of single point mutations}{2}{subsection.1.3.2}\protected@file@percent }
\newlabel{docker:predicting-the-effect-of-a-subset-of-single-point-mutations}{{1.3.2}{2}{Predicting the effect of a subset of single point mutations}{subsection.1.3.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {1.4}Multiple point mutation calculations}{3}{section.1.4}\protected@file@percent }
\newlabel{docker:multiple-point-mutation-calculations}{{1.4}{3}{Multiple point mutation calculations}{section.1.4}{}}
\@writefile{toc}{\contentsline {section}{\numberline {1.5}Running several jobs using docker}{3}{section.1.5}\protected@file@percent }
\newlabel{docker:running-several-jobs-using-docker}{{1.5}{3}{Running several jobs using docker}{section.1.5}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {2}Analyzing the ESGEMME output}{5}{chapter.2}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\newlabel{analysis:analyzing-the-esgemme-output}{{2}{5}{Analyzing the ESGEMME output}{chapter.2}{}}
\newlabel{analysis::doc}{{2}{5}{Analyzing the ESGEMME output}{chapter.2}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {3}Preparing Your Own Input}{7}{chapter.3}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\newlabel{input-preparation:preparing-your-own-input}{{3}{7}{Preparing Your Own Input}{chapter.3}{}}
\newlabel{input-preparation::doc}{{3}{7}{Preparing Your Own Input}{chapter.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {3.1}Preparing Your Input MSA and PDB with Colabfold}{7}{section.3.1}\protected@file@percent }
\newlabel{input-preparation:preparing-your-input-msa-and-pdb-with-colabfold}{{3.1}{7}{Preparing Your Input MSA and PDB with Colabfold}{section.3.1}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {4}Installation}{9}{chapter.4}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\newlabel{installation:installation}{{4}{9}{Installation}{chapter.4}{}}
\newlabel{installation::doc}{{4}{9}{Installation}{chapter.4}{}}
\@writefile{toc}{\contentsline {section}{\numberline {4.1}Installing the dependencies:}{9}{section.4.1}\protected@file@percent }
\newlabel{installation:installing-the-dependencies}{{4.1}{9}{Installing the dependencies:}{section.4.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {4.2}Getting the source code and preparing the environment:}{9}{section.4.2}\protected@file@percent }
\newlabel{installation:getting-the-source-code-and-preparing-the-environment}{{4.2}{9}{Getting the source code and preparing the environment:}{section.4.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {4.3}Configuring default.conf file}{9}{section.4.3}\protected@file@percent }
\newlabel{installation:configuring-default-conf-file}{{4.3}{9}{Configuring default.conf file}{section.4.3}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {5}Indices and tables}{11}{chapter.5}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\newlabel{index:indices-and-tables}{{5}{11}{Indices and tables}{chapter.5}{}}
docs/_build/latex/esgemme.ilg 0 → 100644
This is makeindex, version 2.15 [TeX Live 2019] (kpathsea + Thai support).
Scanning style file ./python.ist.......done (7 attributes redefined, 0 ignored).
Scanning input file esgemme.idx...done (0 entries accepted, 0 rejected).
Nothing written in esgemme.ind.
Transcript written in esgemme.ilg.
docs/_build/latex/sphinx.sty
This source diff could not be displayed because it is too large. You can view the blob instead.
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