website/docs/index.html

   1
   2
   3 <!DOCTYPE html>
   4 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
   5 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
   6 <head>
   7   <meta charset="utf-8">
   8
   9   <meta name="viewport" content="width=device-width, initial-scale=1.0">
  10
  11   <title>Welcome to JABAWS’s documentation! &mdash; JABAWS 2.2 documentation</title>
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29     <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  30
  31
  32
  33
  34
  35         <link rel="index" title="Index"
  36               href="genindex.html"/>
  37         <link rel="search" title="Search" href="search.html"/>
  38     <link rel="top" title="JABAWS 2.2 documentation" href="#"/>
  39         <link rel="next" title="Getting Started" href="getting_started.html"/>
  40
  41
  42   <script src="_static/js/modernizr.min.js"></script>
  43
  44 </head>
  45
  46 <body class="wy-body-for-nav" role="document">
  47
  48
  49   <div class="wy-grid-for-nav">
  50
  51
  52     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  53       <div class="wy-side-scroll">
  54         <div class="wy-side-nav-search">
  55
  56
  57
  58             <a href="#" class="icon icon-home"> JABAWS
  59
  60
  61
  62           </a>
  63
  64
  65
  66
  67               <div class="version">
  68                 2.2
  69               </div>
  70
  71
  72
  73
  74 <div role="search">
  75   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  76     <input type="text" name="q" placeholder="Search docs" />
  77     <input type="hidden" name="check_keywords" value="yes" />
  78     <input type="hidden" name="area" value="default" />
  79   </form>
  80 </div>
  81
  82
  83         </div>
  84
  85         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  86
  87
  88
  89
  90
  91
  92               <p class="caption"><span class="caption-text">Contents:</span></p>
  93 <ul>
  94 <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
  95 <li class="toctree-l1"><a class="reference internal" href="included_tools.html">Included Tools</a></li>
  96 <li class="toctree-l1"><a class="reference internal" href="client.html">Command Line Client (CLI)</a></li>
  97 <li class="toctree-l1"><a class="reference internal" href="war.html">Web Application Archive (WAR)</a></li>
  98 <li class="toctree-l1"><a class="reference internal" href="va.html">Virtual Appliance (VA)</a></li>
  99 <li class="toctree-l1"><a class="reference internal" href="docker.html">Docker Container</a></li>
 100 <li class="toctree-l1"><a class="reference internal" href="advanced.html">Advanced Usage</a></li>
 101 <li class="toctree-l1"><a class="reference internal" href="develop.html">For Developers</a></li>
 102 <li class="toctree-l1"><a class="reference internal" href="stats.html">Usage Statistics</a></li>
 103 <li class="toctree-l1"><a class="reference internal" href="citations.html">Citations</a></li>
 104 <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
 105 </ul>
 106
 107
 108
 109         </div>
 110       </div>
 111     </nav>
 112
 113     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 114
 115
 116       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
 117
 118           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 119           <a href="#">JABAWS</a>
 120
 121       </nav>
 122
 123
 124
 125       <div class="wy-nav-content">
 126         <div class="rst-content">
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143 <div role="navigation" aria-label="breadcrumbs navigation">
 144
 145   <ul class="wy-breadcrumbs">
 146
 147       <li><a href="#">Docs</a> &raquo;</li>
 148
 149       <li>Welcome to JABAWS&#8217;s documentation!</li>
 150
 151
 152       <li class="wy-breadcrumbs-aside">
 153
 154
 155             <!-- <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a> -->
 156             <a href="../">Return to the JABAWS homepage</a>
 157
 158
 159       </li>
 160
 161   </ul>
 162
 163
 164   <hr/>
 165 </div>
 166           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 167            <div itemprop="articleBody">
 168
 169   <div class="section" id="welcome-to-jabaws-s-documentation">
 170 <h1>Welcome to JABAWS&#8217;s documentation!<a class="headerlink" href="#welcome-to-jabaws-s-documentation" title="Permalink to this headline">¶</a></h1>
 171 <p>JABAWS documentation is also available in <em>pdf</em>. <a class="reference external" href="./jabaws_manual.pdf">Download it here</a>!</p>
 172 <div class="toctree-wrapper compound">
 173 <p class="caption"><span class="caption-text">Contents:</span></p>
 174 <ul>
 175 <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a><ul>
 176 <li class="toctree-l2"><a class="reference internal" href="getting_started.html#jabaws-benefits">JABAWS Benefits</a></li>
 177 <li class="toctree-l2"><a class="reference internal" href="getting_started.html#jabaws-distributions">JABAWS Distributions</a><ul>
 178 <li class="toctree-l3"><a class="reference internal" href="getting_started.html#jalview-and-the-jabaws-public-server">Jalview and the JABAWS Public Server</a></li>
 179 <li class="toctree-l3"><a class="reference internal" href="getting_started.html#command-line-client-cli">Command Line Client (CLI)</a></li>
 180 <li class="toctree-l3"><a class="reference internal" href="getting_started.html#web-application-archive-war">Web Application aRchive (WAR)</a></li>
 181 <li class="toctree-l3"><a class="reference internal" href="getting_started.html#virtual-appliance-va">Virtual Appliance (VA)</a></li>
 182 </ul>
 183 </li>
 184 </ul>
 185 </li>
 186 <li class="toctree-l1"><a class="reference internal" href="included_tools.html">Included Tools</a><ul>
 187 <li class="toctree-l2"><a class="reference internal" href="included_tools.html#multiple-sequence-alignment">Multiple Sequence Alignment</a></li>
 188 <li class="toctree-l2"><a class="reference internal" href="included_tools.html#protein-disorder-prediction">Protein Disorder Prediction</a></li>
 189 <li class="toctree-l2"><a class="reference internal" href="included_tools.html#amino-acid-conservation">Amino Acid Conservation</a></li>
 190 <li class="toctree-l2"><a class="reference internal" href="included_tools.html#rna-secondary-structure">RNA Secondary Structure</a></li>
 191 </ul>
 192 </li>
 193 <li class="toctree-l1"><a class="reference internal" href="client.html">Command Line Client (CLI)</a><ul>
 194 <li class="toctree-l2"><a class="reference internal" href="client.html#installing">Installing</a></li>
 195 <li class="toctree-l2"><a class="reference internal" href="client.html#usage">Usage</a></li>
 196 <li class="toctree-l2"><a class="reference internal" href="client.html#example-usage">Example Usage</a></li>
 197 </ul>
 198 </li>
 199 <li class="toctree-l1"><a class="reference internal" href="war.html">Web Application Archive (WAR)</a><ul>
 200 <li class="toctree-l2"><a class="reference internal" href="war.html#installing">Installing</a></li>
 201 <li class="toctree-l2"><a class="reference internal" href="war.html#usage">Usage</a></li>
 202 <li class="toctree-l2"><a class="reference internal" href="war.html#troubleshooting">Troubleshooting</a></li>
 203 </ul>
 204 </li>
 205 <li class="toctree-l1"><a class="reference internal" href="va.html">Virtual Appliance (VA)</a><ul>
 206 <li class="toctree-l2"><a class="reference internal" href="va.html#installing">Installing</a></li>
 207 <li class="toctree-l2"><a class="reference internal" href="va.html#usage">Usage</a></li>
 208 <li class="toctree-l2"><a class="reference internal" href="va.html#configuration">Configuration</a><ul>
 209 <li class="toctree-l3"><a class="reference internal" href="va.html#vm-configuration">VM configuration</a></li>
 210 <li class="toctree-l3"><a class="reference internal" href="va.html#jabaws-configuration">JABAWS configuration</a></li>
 211 </ul>
 212 </li>
 213 </ul>
 214 </li>
 215 <li class="toctree-l1"><a class="reference internal" href="docker.html">Docker Container</a><ul>
 216 <li class="toctree-l2"><a class="reference internal" href="docker.html#installing-docker">Installing Docker</a></li>
 217 <li class="toctree-l2"><a class="reference internal" href="docker.html#running-jabaws-with-docker">Running JABAWS with Docker</a></li>
 218 </ul>
 219 </li>
 220 <li class="toctree-l1"><a class="reference internal" href="advanced.html">Advanced Usage</a><ul>
 221 <li class="toctree-l2"><a class="reference internal" href="advanced.html#valid-wsdl">Valid WSDL</a></li>
 222 <li class="toctree-l2"><a class="reference internal" href="advanced.html#jabaws-configuration">JABAWS Configuration</a><ul>
 223 <li class="toctree-l3"><a class="reference internal" href="advanced.html#local-engine-configuration">Local Engine Configuration</a></li>
 224 <li class="toctree-l3"><a class="reference internal" href="advanced.html#cluster-engine-configuration">Cluster Engine Configuration</a></li>
 225 <li class="toctree-l3"><a class="reference internal" href="advanced.html#executable-configuration">Executable Configuration</a></li>
 226 <li class="toctree-l3"><a class="reference internal" href="advanced.html#defining-environment-variables-for-executables">Defining Environment Variables for Executables</a></li>
 227 <li class="toctree-l3"><a class="reference internal" href="advanced.html#configure-jabaws-to-work-with-mafft">Configure JABAWS to Work with Mafft</a></li>
 228 <li class="toctree-l3"><a class="reference internal" href="advanced.html#limiting-the-size-of-the-job-accepted-by-jabaws">Limiting the size of the job accepted by JABAWS</a></li>
 229 <li class="toctree-l3"><a class="reference internal" href="advanced.html#pre-compiled-binaries">Pre-compiled binaries</a></li>
 230 <li class="toctree-l3"><a class="reference internal" href="advanced.html#recompiling-binaries-for-your-system">Recompiling binaries for your system</a></li>
 231 <li class="toctree-l3"><a class="reference internal" href="advanced.html#obtaining-or-reusing-binaries">Obtaining or reusing binaries</a></li>
 232 </ul>
 233 </li>
 234 <li class="toctree-l2"><a class="reference internal" href="advanced.html#load-balancing">Load balancing</a></li>
 235 <li class="toctree-l2"><a class="reference internal" href="advanced.html#testing-the-jabaws-server">Testing the JABAWS Server</a></li>
 236 <li class="toctree-l2"><a class="reference internal" href="advanced.html#jabaws-internal-logging">JABAWS internal logging</a><ul>
 237 <li class="toctree-l3"><a class="reference internal" href="advanced.html#jabaws-requests-logging">JABAWS requests logging</a></li>
 238 </ul>
 239 </li>
 240 <li class="toctree-l2"><a class="reference internal" href="advanced.html#jabaws-and-google-analytics">JABAWS and Google Analytics</a></li>
 241 <li class="toctree-l2"><a class="reference internal" href="advanced.html#jabaws-war-file-content">JABAWS War File Content</a></li>
 242 </ul>
 243 </li>
 244 <li class="toctree-l1"><a class="reference internal" href="develop.html">For Developers</a><ul>
 245 <li class="toctree-l2"><a class="reference internal" href="develop.html#source-code">Source Code</a></li>
 246 <li class="toctree-l2"><a class="reference internal" href="develop.html#the-api">The API</a></li>
 247 <li class="toctree-l2"><a class="reference internal" href="develop.html#structure-of-the-project">Structure of the project</a></li>
 248 <li class="toctree-l2"><a class="reference internal" href="develop.html#the-code-structure">The code structure</a></li>
 249 <li class="toctree-l2"><a class="reference internal" href="develop.html#unit-testing">Unit Testing</a></li>
 250 <li class="toctree-l2"><a class="reference internal" href="develop.html#accessing-jabaws-from-your-program">Accessing JABAWS from your program</a><ul>
 251 <li class="toctree-l3"><a class="reference internal" href="develop.html#web-services-functions-overview">Web services functions overview</a></li>
 252 <li class="toctree-l3"><a class="reference internal" href="develop.html#structure-of-the-template-command-line-client">Structure of the template command line client</a></li>
 253 <li class="toctree-l3"><a class="reference internal" href="develop.html#connecting-to-jabaws">Connecting to JABAWS</a></li>
 254 <li class="toctree-l3"><a class="reference internal" href="develop.html#aligning-sequences">Aligning Sequences</a></li>
 255 <li class="toctree-l3"><a class="reference internal" href="develop.html#checking-the-status-of-the-calculation">Checking the status of the calculation</a></li>
 256 <li class="toctree-l3"><a class="reference internal" href="develop.html#aligning-with-presets">Aligning with presets</a></li>
 257 <li class="toctree-l3"><a class="reference internal" href="develop.html#aligning-with-custom-parameters">Aligning with custom parameters</a></li>
 258 <li class="toctree-l3"><a class="reference internal" href="develop.html#writing-alignments-to-a-file">Writing alignments to a file</a></li>
 259 <li class="toctree-l3"><a class="reference internal" href="develop.html#a-complete-client-example">A complete client example</a></li>
 260 </ul>
 261 </li>
 262 <li class="toctree-l2"><a class="reference internal" href="develop.html#adding-new-web-services">Adding new web-services</a><ul>
 263 <li class="toctree-l3"><a class="reference internal" href="develop.html#brief-guide">Brief Guide</a></li>
 264 <li class="toctree-l3"><a class="reference internal" href="develop.html#building-web-services-artifacts">Building web services artifacts</a></li>
 265 <li class="toctree-l3"><a class="reference internal" href="develop.html#preparing-distributives">Preparing Distributives</a></li>
 266 </ul>
 267 </li>
 268 </ul>
 269 </li>
 270 <li class="toctree-l1"><a class="reference internal" href="stats.html">Usage Statistics</a><ul>
 271 <li class="toctree-l2"><a class="reference internal" href="stats.html#detailed-view">Detailed View</a></li>
 272 <li class="toctree-l2"><a class="reference internal" href="stats.html#job-list">Job List</a></li>
 273 <li class="toctree-l2"><a class="reference internal" href="stats.html#job-directory-contents">Job Directory Contents</a></li>
 274 <li class="toctree-l2"><a class="reference internal" href="stats.html#configuring-jabaws-execution-statistics">Configuring JABAWS execution statistics</a></li>
 275 <li class="toctree-l2"><a class="reference internal" href="stats.html#configuring-a-privileged-access-for-tomcat-web-application-server">Configuring a privileged access for Tomcat web application server</a></li>
 276 </ul>
 277 </li>
 278 <li class="toctree-l1"><a class="reference internal" href="citations.html">Citations</a></li>
 279 <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
 280 <li class="toctree-l2"><a class="reference internal" href="changelog.html#version-2-2-released-02-june-2017">Version 2.2 (Released 02 June 2017)</a></li>
 281 <li class="toctree-l2"><a class="reference internal" href="changelog.html#version-2-1-released-1st-oct-2013">Version 2.1 (Released 1st Oct 2013)</a></li>
 282 <li class="toctree-l2"><a class="reference internal" href="changelog.html#version-2-0-1-released-2nd-jul-2013">Version 2.0.1 (Released 2nd Jul 2013)</a></li>
 283 <li class="toctree-l2"><a class="reference internal" href="changelog.html#version-2-released-16th-dec-2011">Version 2 (Released 16th Dec 2011)</a></li>
 284 </ul>
 285 </li>
 286 </ul>
 287 </div>
 288 <hr class="docutils" />
 289 <div class="admonition note">
 290 <p class="first admonition-title">Note</p>
 291 <p class="last">This is an open source project. If you want to contribute or report an issue have a look at our  <a class="reference external" href="https://source.jalview.org/crucible/changelog/jabaws">Git-tracker</a>.</p>
 292 </div>
 293 </div>
 294
 295
 296            </div>
 297            <div class="articleComments">
 298
 299            </div>
 300           </div>
 301           <footer>
 302
 303     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 304
 305         <a href="getting_started.html" class="btn btn-neutral float-right" title="Getting Started" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 306
 307
 308     </div>
 309
 310
 311   <hr/>
 312
 313   <div role="contentinfo">
 314     <p><a href="../">JABAWS 2.2</a>
 315         &copy; Copyright 2017, Peter Troshin, Alexander Sherstnev, Jim Procter, Daniel Barton, Fábio Madeira, Alexey Drozdetskiy, Suzanne Duce and Geoff Barton.
 316
 317     </p>
 318   </div>
 319   Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
 320
 321 </footer>
 322         </div>
 323       </div>
 324
 325     </section>
 326
 327   </div>
 328
 329
 330
 331
 332
 333     <script type="text/javascript">
 334         var DOCUMENTATION_OPTIONS = {
 335             URL_ROOT:'./',
 336             VERSION:'2.2',
 337             LANGUAGE:'None',
 338             COLLAPSE_INDEX:false,
 339             FILE_SUFFIX:'.html',
 340             HAS_SOURCE:  true,
 341             SOURCELINK_SUFFIX: '.txt'
 342         };
 343     </script>
 344       <script type="text/javascript" src="_static/jquery.js"></script>
 345       <script type="text/javascript" src="_static/underscore.js"></script>
 346       <script type="text/javascript" src="_static/doctools.js"></script>
 347
 348
 349
 350
 351
 352     <script type="text/javascript" src="_static/js/theme.js"></script>
 353
 354
 355
 356
 357   <script type="text/javascript">
 358       jQuery(function () {
 359           SphinxRtdTheme.StickyNav.enable();
 360       });
 361   </script>
 362
 363
 364 </body>
 365 </html>