Skip to content
Snippets Groups Projects
Commit a0e6a639 authored by Bienchen's avatar Bienchen
Browse files

Update documentation

parent 28cc836e
No related branches found
No related tags found
No related merge requests found
Expand all Hide whitespace changes
Inline Side-by-side
Showing
with 65 additions and 54 deletions
run_af2/doc/html/.buildinfo
+ 1
− 1
View file @ a0e6a639
# 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: 28b0c8014ab9635fcc7ca0d345e21e72
config: b9aa92d5a319ad1e85a69d45f2e2182e
tags: 645f666f9bcd5a90fca523b33c5a78b7
run_af2/doc/html/.doctrees/environment.pickle
+ 0
− 0
View file @ a0e6a639
No preview for this file type
run_af2/doc/html/.doctrees/index.doctree
+ 0
− 0
View file @ a0e6a639
No preview for this file type
run_af2/doc/html/.doctrees/run_singularity.doctree
+ 0
− 0
View file @ a0e6a639
No preview for this file type
run_af2/doc/html/_shared.html
+ 6
− 6
View file @ a0e6a639
......@@ -6,7 +6,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>_shared &#8212; af2@scicore/run_af2 1.0.5 documentation</title>
<title>_shared &#8212; af2@scicore/run_af2 2.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/sphinxdoc.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
......@@ -33,7 +33,7 @@
<li class="right" >
<a href="index.html" title="Welcome to af2@scicore/run_af2’s documentation!"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">af2@scicore/run_af2 1.0.5 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">af2@scicore/run_af2 2.0.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">_shared</a></li>
</ul>
</div>
......@@ -67,12 +67,12 @@ creates the version file.</p>
<span class="sig-prename descclassname"><span class="pre">run_af2._shared.</span></span><span class="sig-name descname"><span class="pre">parse_af2_arguments</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parser</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#run_af2._shared.parse_af2_arguments" title="Permalink to this definition"></a></dt>
<dd><p>AF2 pipeline arguments parsing capabilities.</p>
<p>Add arguments common for running the AF2 pipeline to an existing
<a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">argparse.ArgumentParser</span></code></a> object. Run the parser and return the
<a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">argparse.ArgumentParser</span></code></a> object. Run the parser and return the
result. That way tools can implement their own description for the parser
and run tests on input with the <a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">argparse.Namespace</span></code></a> object.</p>
and run tests on input with the <a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">argparse.Namespace</span></code></a> object.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">argparse.Namespace</span></code></a> object from
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">argparse.Namespace</span></code></a> object from
<cite>argparse.ArgumentParser.parse_args</cite>.</p>
</dd>
</dl>
......@@ -129,7 +129,7 @@ and run tests on input with the <a class="reference external" href="https://docs
<li class="right" >
<a href="index.html" title="Welcome to af2@scicore/run_af2’s documentation!"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">af2@scicore/run_af2 1.0.5 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">af2@scicore/run_af2 2.0.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">_shared</a></li>
</ul>
</div>
......
run_af2/doc/html/_static/documentation_options.js
+ 1
− 1
View file @ a0e6a639
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '1.0.5',
VERSION: '2.0.0',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',
......
run_af2/doc/html/genindex.html
+ 3
− 3
View file @ a0e6a639
......@@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &#8212; af2@scicore/run_af2 1.0.5 documentation</title>
<title>Index &#8212; af2@scicore/run_af2 2.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/sphinxdoc.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
......@@ -24,7 +24,7 @@
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">af2@scicore/run_af2 1.0.5 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">af2@scicore/run_af2 2.0.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Index</a></li>
</ul>
</div>
......@@ -132,7 +132,7 @@
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">af2@scicore/run_af2 1.0.5 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">af2@scicore/run_af2 2.0.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Index</a></li>
</ul>
</div>
......
run_af2/doc/html/index.html
+ 4
− 4
View file @ a0e6a639
......@@ -6,7 +6,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>Welcome to af2@scicore/run_af2’s documentation! &#8212; af2@scicore/run_af2 1.0.5 documentation</title>
<title>Welcome to af2@scicore/run_af2’s documentation! &#8212; af2@scicore/run_af2 2.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/sphinxdoc.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
......@@ -29,7 +29,7 @@
<li class="right" >
<a href="_shared.html" title="_shared"
accesskey="N">next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">af2@scicore/run_af2 1.0.5 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="#">af2@scicore/run_af2 2.0.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Welcome to af2&#64;scicore/run_af2’s documentation!</a></li>
</ul>
</div>
......@@ -41,7 +41,7 @@
<section id="welcome-to-af2-scicore-run-af2-s-documentation">
<h1>Welcome to af2&#64;scicore/run_af2’s documentation!<a class="headerlink" href="#welcome-to-af2-scicore-run-af2-s-documentation" title="Permalink to this headline"></a></h1>
<p>You are reading the documentation for version 1.0 (release 1.0.5)
<p>You are reading the documentation for version 2.0 (release 2.0.0)
of <strong>run_af2</strong>.</p>
<p><strong>run_af2</strong> is a Python package to run the <a class="reference external" href="https://github.com/deepmind/alphafold">AlphaFold 2 (AF2) pipeline</a> on the sciCORE cluster.</p>
<p>The package comes with two major parts: userland commands to just execute the
......@@ -114,7 +114,7 @@ Python modules is here:</p>
<li class="right" >
<a href="_shared.html" title="_shared"
>next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">af2@scicore/run_af2 1.0.5 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="#">af2@scicore/run_af2 2.0.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Welcome to af2&#64;scicore/run_af2’s documentation!</a></li>
</ul>
</div>
......
run_af2/doc/html/objects.inv
+ 0
− 0
View file @ a0e6a639
No preview for this file type
run_af2/doc/html/py-modindex.html
+ 3
− 3
View file @ a0e6a639
......@@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Python Module Index &#8212; af2@scicore/run_af2 1.0.5 documentation</title>
<title>Python Module Index &#8212; af2@scicore/run_af2 2.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/sphinxdoc.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
......@@ -27,7 +27,7 @@
<li class="right" >
<a href="#" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">af2@scicore/run_af2 1.0.5 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">af2@scicore/run_af2 2.0.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Python Module Index</a></li>
</ul>
</div>
......@@ -96,7 +96,7 @@
<li class="right" >
<a href="#" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">af2@scicore/run_af2 1.0.5 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">af2@scicore/run_af2 2.0.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Python Module Index</a></li>
</ul>
</div>
......
run_af2/doc/html/run_singularity.html
+ 43
− 32
View file @ a0e6a639
This diff is collapsed.
run_af2/doc/html/search.html
+ 3
− 3
View file @ a0e6a639
......@@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Search &#8212; af2@scicore/run_af2 1.0.5 documentation</title>
<title>Search &#8212; af2@scicore/run_af2 2.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/sphinxdoc.css" />
......@@ -30,7 +30,7 @@
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">af2@scicore/run_af2 1.0.5 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">af2@scicore/run_af2 2.0.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Search</a></li>
</ul>
</div>
......@@ -89,7 +89,7 @@
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">af2@scicore/run_af2 1.0.5 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">af2@scicore/run_af2 2.0.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Search</a></li>
</ul>
</div>
......
run_af2/doc/html/searchindex.js
+ 1
− 1
View file @ a0e6a639
Search.setIndex({docnames:["_shared","index","run_singularity"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"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.ext.intersphinx":1,sphinx:56},filenames:["_shared.rst","index.rst","run_singularity.rst"],objects:{"run_af2._shared":{get_version:[0,1,1,""],parse_af2_arguments:[0,1,1,""]},"run_af2.run_singularity":{main:[2,1,1,""],run_af2_singularity_image:[2,1,1,""]},run_af2:{_shared:[0,0,0,"-"],run_singularity:[2,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:function"},terms:{"0":1,"1":1,"2":[1,2],"3":[],"4":[],"5":1,"case":0,"default":2,"export":[],"function":0,"import":0,"return":[0,2],A:[0,2],By:2,If:[0,2],Not:[],That:0,The:[1,2],There:2,_share:1,access:1,add:0,af2:[0,2],af2_image_dir:2,af2_image_fil:2,af2param:2,after:[0,2],all:2,alphafold2:2,alphafold:[1,2],alphafold_data:2,an:[0,2],ar:[1,2],argpars:0,argument:[0,2],argumentpars:0,avail:2,basenam:2,bfd:2,bfd_database_path:2,bfd_metaclust_clu_complete_id30_c90_final_seq:2,bfd_small:2,bin:2,binari:2,bool:2,build:0,call:2,can:[0,1],capabl:0,cfg:0,cluster:[1,2],come:[1,2],command:1,common:0,configur:2,consid:2,contain:2,correspond:2,creat:0,dat:2,data:2,data_dir:2,databas:2,date:2,dd:2,declar:2,defin:2,deliv:0,descript:0,did:0,directori:[0,2],dl:2,download_dir:2,effect:2,ensembl:2,entri:2,environ:2,everi:2,execut:[1,2],exist:0,extern:0,fa:2,fail:2,fals:2,fasta:2,fasta_fil:2,file:[0,2],first:[],first_non_consensus_sequ:2,form:2,found:1,from:[0,1,2],frozen_181015t170110:2,frozen_210805t085238:2,frozen_210805t103002:2,frozen_210805t142857:2,frozen_210805t171956:2,frozen_210812t135116:2,full:2,full_db:2,genet:2,get_vers:0,gitlab:1,gpu:2,group:2,ha:2,happen:0,here:1,hhblit:2,hold:2,home:2,host:2,imag:2,implement:0,includ:2,index:1,input:0,itself:0,just:[1,2],keyword:2,larg:2,latest:2,list:2,load:0,m:0,main:2,major:1,manag:2,map:2,max_template_d:2,mgnifi:2,mgnify_database_path:2,mgy_clusters_2018_12:2,mm:2,mmcif_fil:2,mode:2,model:2,model_nam:2,modul:[0,1,2],must:2,name:2,namespac:0,necessarili:2,need:[0,2],none:2,noth:2,object:0,obsolet:2,obsolete_pdbs_path:2,onc:0,one:2,onli:[0,2],other:0,output:2,output_dir:2,outsid:0,own:[0,1],packag:[0,1],page:1,param:2,paramet:2,pars:0,parse_af2_argu:0,parse_arg:0,parser:0,part:1,path:2,pdb70:2,pdb70_database_path:2,pdb:2,per:2,pipelin:[0,1,2],prefix:2,preset:2,programmat:1,proper:0,python:[0,1,2],rais:2,read:1,reduced_db:2,releas:[1,2],replac:2,repositori:1,request:0,result:[0,2],run:[0,1,2],run_af2:[0,2],run_af2_singularity_imag:2,run_singular:1,runtimeerror:2,same:0,schwede:2,scicor:2,script:[1,2],search:1,separ:2,sequenc:2,set:2,setup:0,share:0,should:[0,2],sif:2,sinc:0,singular:2,small:2,small_bfd_database_path:2,smaller:2,snglrty_bin:2,so:2,soft:[],some:[0,2],sorted_opt:2,space:2,statu:2,str:2,string:0,structur:2,sub:2,system:2,target:2,templat:2,template_mmcif_dir:2,test:0,them:2,thi:[0,2],tmp:2,tmpdir:2,tmpdir_var:2,tomorrow:2,tool:0,two:[1,2],uniclust30:2,uniclust30_2018_08:2,uniclust30_database_path:2,uniclust:2,uniprot:2,uniqu:2,uniref90:2,uniref90_database_path:2,uniref:2,upon:0,us:[0,2],use_gpu:2,userland:1,usr:2,variabl:2,version:[0,1],wai:0,we:0,which:2,x:0,you:[0,1],your:1,yyyi:2},titles:["_shared","Welcome to af2&#64;scicore/run_af2\u2019s documentation!","run_singularity"],titleterms:{_share:0,af2:1,document:1,indic:1,run_af2:1,run_singular:2,s:1,scicor:1,tabl:1,welcom:1}})
\ No newline at end of file
Search.setIndex({docnames:["_shared","index","run_singularity"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"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.ext.intersphinx":1,sphinx:56},filenames:["_shared.rst","index.rst","run_singularity.rst"],objects:{"run_af2._shared":{get_version:[0,1,1,""],parse_af2_arguments:[0,1,1,""]},"run_af2.run_singularity":{main:[2,1,1,""],run_af2_singularity_image:[2,1,1,""]},run_af2:{_shared:[0,0,0,"-"],run_singularity:[2,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:function"},terms:{"0":1,"1":[],"2":[1,2],"3":[],"4":[],"5":[],"case":0,"default":2,"export":[],"function":0,"import":0,"return":[0,2],"true":2,A:[0,2],By:2,For:2,If:[0,2],Not:[],That:0,The:[1,2],There:2,Will:2,_share:1,access:1,add:0,af2:[0,2],af2_image_dir:2,af2_image_fil:2,af2param:[],after:[0,2],all:2,alphafold2:2,alphafold:[1,2],alphafold_data:2,an:[0,2],ar:[1,2],argpars:0,argument:[0,2],argumentpars:0,avail:2,basenam:2,bfd:2,bfd_database_path:2,bfd_metaclust_clu_complete_id30_c90_final_seq:2,bfd_small:2,bin:2,binari:2,bool:2,build:0,call:2,can:[0,1],capabl:0,cfg:0,cluster:[1,2],come:[1,2],command:1,common:0,configur:2,consid:2,contain:2,correspond:2,creat:0,dat:2,data:2,data_dir:2,databas:2,date:2,db_preset:2,dd:2,declar:2,defin:2,deliv:0,descript:0,did:0,directori:[0,2],disabl:2,dl:[],download_dir:2,e:2,effect:2,ensembl:[],entri:2,environ:2,everi:2,execut:[1,2],exist:0,extern:0,fa:2,fail:2,fals:2,fasta:2,fasta_fil:2,file:[0,2],first:[],first_non_consensus_sequ:2,form:2,found:1,from:[0,1,2],frozen_181015t170110:2,frozen_210805t085238:2,frozen_210805t103002:2,frozen_210805t142857:2,frozen_210805t171956:[],frozen_210812t135116:2,full:2,full_db:2,g:2,genet:2,get_vers:0,gitlab:1,gpu:2,group:2,ha:2,happen:0,here:1,hhblit:2,hold:2,home:2,host:2,imag:2,implement:0,includ:2,index:1,input:0,is_prokaryote_list:2,itself:0,just:[1,2],keyword:2,larg:2,latest:2,like:2,list:2,load:0,m:0,main:2,major:1,manag:2,map:2,mark:2,max_template_d:2,mgnifi:2,mgnify_database_path:2,mgy_clusters_2018_12:2,mm:2,mmcif_fil:2,mode:2,model:2,model_nam:[],model_preset:2,modul:[0,1,2],monom:2,multim:2,must:2,name:2,namespac:0,necessarili:2,need:[0,2],none:2,noth:2,object:0,obsolet:2,obsolete_pdbs_path:2,onc:0,one:2,onli:[0,2],other:0,output:2,output_dir:2,outsid:0,own:[0,1],packag:[0,1],page:1,param:2,paramet:2,pars:0,parse_af2_argu:0,parse_arg:0,parser:0,part:1,path:2,pdb70:2,pdb70_database_path:2,pdb:2,pdb_mmcif:2,pdb_seqr:2,pdb_seqres_database_path:2,per:2,pipelin:[0,1,2],prefix:2,preset:[],programmat:1,prokaryot:2,proper:0,python:[0,1,2],rais:2,read:1,reduced_db:2,releas:[1,2],replac:2,repositori:1,request:0,result:[0,2],run:[0,1,2],run_af2:[0,2],run_af2_singularity_imag:2,run_singular:1,runtimeerror:2,same:0,schwede:2,scicor:2,script:[1,2],search:1,separ:2,seqr:2,sequenc:2,set:2,setup:0,share:0,should:[0,2],sif:2,sinc:0,singular:2,small:2,small_bfd_database_path:2,smaller:2,snglrty_bin:2,so:2,soft:[],some:[0,2],sorted_opt:2,space:2,statu:[],str:2,string:0,structur:2,sub:2,system:2,target:2,templat:2,template_mmcif_dir:2,test:0,them:2,thi:[0,2],tmp:2,tmpdir:2,tmpdir_var:2,tomorrow:2,tool:0,two:[1,2],txt:2,uniclust30:2,uniclust30_2018_08:2,uniclust30_database_path:2,uniclust:2,uniprot:2,uniprot_database_path:2,uniqu:2,uniref90:2,uniref90_database_path:2,uniref:2,upon:0,us:[0,2],use_gpu:2,userland:1,usr:2,variabl:2,version:[0,1],wai:0,we:0,which:2,x:0,you:[0,1],your:1,yyyi:2},titles:["_shared","Welcome to af2&#64;scicore/run_af2\u2019s documentation!","run_singularity"],titleterms:{_share:0,af2:1,document:1,indic:1,run_af2:1,run_singular:2,s:1,scicor:1,tabl:1,welcom:1}})
\ No newline at end of file
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment