doc/building.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   5   <meta http-equiv="Content-Style-Type" content="text/css" />
   6   <meta name="generator" content="pandoc" />
   7   <title>Building Jalview from Source</title>
   8   <style type="text/css">code{white-space: pre;}</style>
   9   <style type="text/css">
  10 div.sourceCode { overflow-x: auto; }
  11 table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
  12   margin: 0; padding: 0; vertical-align: baseline; border: none; }
  13 table.sourceCode { width: 100%; line-height: 100%; }
  14 td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
  15 td.sourceCode { padding-left: 5px; }
  16 code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
  17 code > span.dt { color: #902000; } /* DataType */
  18 code > span.dv { color: #40a070; } /* DecVal */
  19 code > span.bn { color: #40a070; } /* BaseN */
  20 code > span.fl { color: #40a070; } /* Float */
  21 code > span.ch { color: #4070a0; } /* Char */
  22 code > span.st { color: #4070a0; } /* String */
  23 code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
  24 code > span.ot { color: #007020; } /* Other */
  25 code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
  26 code > span.fu { color: #06287e; } /* Function */
  27 code > span.er { color: #ff0000; font-weight: bold; } /* Error */
  28 code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
  29 code > span.cn { color: #880000; } /* Constant */
  30 code > span.sc { color: #4070a0; } /* SpecialChar */
  31 code > span.vs { color: #4070a0; } /* VerbatimString */
  32 code > span.ss { color: #bb6688; } /* SpecialString */
  33 code > span.im { } /* Import */
  34 code > span.va { color: #19177c; } /* Variable */
  35 code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
  36 code > span.op { color: #666666; } /* Operator */
  37 code > span.bu { } /* BuiltIn */
  38 code > span.ex { } /* Extension */
  39 code > span.pp { color: #bc7a00; } /* Preprocessor */
  40 code > span.at { color: #7d9029; } /* Attribute */
  41 code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
  42 code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
  43 code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
  44 code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
  45   </style>
  46   <style>
  47   @font-face {
  48     font-family: octicons-link;
  49     src: url(data:font/woff;charset=utf-8;base64,d09GRgABAAAAAAZwABAAAAAACFQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABEU0lHAAAGaAAAAAgAAAAIAAAAAUdTVUIAAAZcAAAACgAAAAoAAQAAT1MvMgAAAyQAAABJAAAAYFYEU3RjbWFwAAADcAAAAEUAAACAAJThvmN2dCAAAATkAAAABAAAAAQAAAAAZnBnbQAAA7gAAACyAAABCUM+8IhnYXNwAAAGTAAAABAAAAAQABoAI2dseWYAAAFsAAABPAAAAZwcEq9taGVhZAAAAsgAAAA0AAAANgh4a91oaGVhAAADCAAAABoAAAAkCA8DRGhtdHgAAAL8AAAADAAAAAwGAACfbG9jYQAAAsAAAAAIAAAACABiATBtYXhwAAACqAAAABgAAAAgAA8ASm5hbWUAAAToAAABQgAAAlXu73sOcG9zdAAABiwAAAAeAAAAME3QpOBwcmVwAAAEbAAAAHYAAAB/aFGpk3jaTY6xa8JAGMW/O62BDi0tJLYQincXEypYIiGJjSgHniQ6umTsUEyLm5BV6NDBP8Tpts6F0v+k/0an2i+itHDw3v2+9+DBKTzsJNnWJNTgHEy4BgG3EMI9DCEDOGEXzDADU5hBKMIgNPZqoD3SilVaXZCER3/I7AtxEJLtzzuZfI+VVkprxTlXShWKb3TBecG11rwoNlmmn1P2WYcJczl32etSpKnziC7lQyWe1smVPy/Lt7Kc+0vWY/gAgIIEqAN9we0pwKXreiMasxvabDQMM4riO+qxM2ogwDGOZTXxwxDiycQIcoYFBLj5K3EIaSctAq2kTYiw+ymhce7vwM9jSqO8JyVd5RH9gyTt2+J/yUmYlIR0s04n6+7Vm1ozezUeLEaUjhaDSuXHwVRgvLJn1tQ7xiuVv/ocTRF42mNgZGBgYGbwZOBiAAFGJBIMAAizAFoAAABiAGIAznjaY2BkYGAA4in8zwXi+W2+MjCzMIDApSwvXzC97Z4Ig8N/BxYGZgcgl52BCSQKAA3jCV8CAABfAAAAAAQAAEB42mNgZGBg4f3vACQZQABIMjKgAmYAKEgBXgAAeNpjYGY6wTiBgZWBg2kmUxoDA4MPhGZMYzBi1AHygVLYQUCaawqDA4PChxhmh/8ODDEsvAwHgMKMIDnGL0x7gJQCAwMAJd4MFwAAAHjaY2BgYGaA4DAGRgYQkAHyGMF8NgYrIM3JIAGVYYDT+AEjAwuDFpBmA9KMDEwMCh9i/v8H8sH0/4dQc1iAmAkALaUKLgAAAHjaTY9LDsIgEIbtgqHUPpDi3gPoBVyRTmTddOmqTXThEXqrob2gQ1FjwpDvfwCBdmdXC5AVKFu3e5MfNFJ29KTQT48Ob9/lqYwOGZxeUelN2U2R6+cArgtCJpauW7UQBqnFkUsjAY/kOU1cP+DAgvxwn1chZDwUbd6CFimGXwzwF6tPbFIcjEl+vvmM/byA48e6tWrKArm4ZJlCbdsrxksL1AwWn/yBSJKpYbq8AXaaTb8AAHja28jAwOC00ZrBeQNDQOWO//sdBBgYGRiYWYAEELEwMTE4uzo5Zzo5b2BxdnFOcALxNjA6b2ByTswC8jYwg0VlNuoCTWAMqNzMzsoK1rEhNqByEyerg5PMJlYuVueETKcd/89uBpnpvIEVomeHLoMsAAe1Id4AAAAAAAB42oWQT07CQBTGv0JBhagk7HQzKxca2sJCE1hDt4QF+9JOS0nbaaYDCQfwCJ7Au3AHj+LO13FMmm6cl7785vven0kBjHCBhfpYuNa5Ph1c0e2Xu3jEvWG7UdPDLZ4N92nOm+EBXuAbHmIMSRMs+4aUEd4Nd3CHD8NdvOLTsA2GL8M9PODbcL+hD7C1xoaHeLJSEao0FEW14ckxC+TU8TxvsY6X0eLPmRhry2WVioLpkrbp84LLQPGI7c6sOiUzpWIWS5GzlSgUzzLBSikOPFTOXqly7rqx0Z1Q5BAIoZBSFihQYQOOBEdkCOgXTOHA07HAGjGWiIjaPZNW13/+lm6S9FT7rLHFJ6fQbkATOG1j2OFMucKJJsxIVfQORl+9Jyda6Sl1dUYhSCm1dyClfoeDve4qMYdLEbfqHf3O/AdDumsjAAB42mNgYoAAZQYjBmyAGYQZmdhL8zLdDEydARfoAqIAAAABAAMABwAKABMAB///AA8AAQAAAAAAAAAAAAAAAAABAAAAAA==) format('woff');
  50   }
  51
  52   body {
  53     -webkit-text-size-adjust: 100%;
  54     text-size-adjust: 100%;
  55     color: #333;
  56     font-family: "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
  57     font-size: 16px;
  58     line-height: 1.6;
  59     word-wrap: break-word;
  60     width: 728px;
  61     max-width: 99%;
  62     box-sizing: border-box;
  63     padding: 30px 30px 8rem 30px;
  64     margin-left: auto;
  65     margin-right: auto;
  66   }
  67
  68   body a {
  69     background-color: transparent;
  70   }
  71
  72   body a:active,
  73   body a:hover {
  74     outline: 0;
  75   }
  76
  77   body strong {
  78     font-weight: bold;
  79   }
  80
  81   body h1 {
  82     font-size: 2em;
  83     margin: 0.67em 0;
  84   }
  85
  86   body img {
  87     border: 0;
  88   }
  89
  90   body hr {
  91     box-sizing: content-box;
  92     height: 0;
  93   }
  94
  95   body pre {
  96     overflow: auto;
  97   }
  98
  99   body code,
 100   body kbd,
 101   body pre {
 102     font-family: monospace, monospace;
 103     font-size: 1em;
 104   }
 105
 106   body input {
 107     color: inherit;
 108     font: inherit;
 109     margin: 0;
 110   }
 111
 112   body html input[disabled] {
 113     cursor: default;
 114   }
 115
 116   body input {
 117     line-height: normal;
 118   }
 119
 120   body input[type="checkbox"] {
 121     box-sizing: border-box;
 122     padding: 0;
 123   }
 124
 125   body table {
 126     border-collapse: collapse;
 127     border-spacing: 0;
 128   }
 129
 130   body td,
 131   body th {
 132     padding: 0;
 133   }
 134
 135   body * {
 136     box-sizing: border-box;
 137   }
 138
 139   body input {
 140     font: 13px / 1.4 Helvetica, arial, nimbussansl, liberationsans, freesans, clean, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
 141   }
 142
 143   body a {
 144     color: #4078c0;
 145     text-decoration: none;
 146   }
 147
 148   body a:hover,
 149   body a:active {
 150     text-decoration: underline;
 151   }
 152
 153   body hr {
 154     height: 0;
 155     margin: 15px 0;
 156     overflow: hidden;
 157     background: transparent;
 158     border: 0;
 159     border-bottom: 1px solid #ddd;
 160   }
 161
 162   body hr:before {
 163     display: table;
 164     content: "";
 165   }
 166
 167   body hr:after {
 168     display: table;
 169     clear: both;
 170     content: "";
 171   }
 172
 173   body h1,
 174   body h2,
 175   body h3,
 176   body h4,
 177   body h5,
 178   body h6 {
 179     margin-top: 15px;
 180     margin-bottom: 15px;
 181     line-height: 1.1;
 182   }
 183
 184   body h1 {
 185     font-size: 30px;
 186   }
 187
 188   body h2 {
 189     font-size: 21px;
 190   }
 191
 192   body h3 {
 193     font-size: 16px;
 194   }
 195
 196   body h4 {
 197     font-size: 14px;
 198   }
 199
 200   body h5 {
 201     font-size: 12px;
 202   }
 203
 204   body h6 {
 205     font-size: 11px;
 206   }
 207
 208   body blockquote {
 209     margin: 0;
 210   }
 211
 212   body ul,
 213   body ol {
 214     padding: 0;
 215     margin-top: 0;
 216     margin-bottom: 0;
 217   }
 218
 219   body ol ol,
 220   body ul ol {
 221     list-style-type: lower-roman;
 222   }
 223
 224   body ul ul ol,
 225   body ul ol ol,
 226   body ol ul ol,
 227   body ol ol ol {
 228     list-style-type: lower-alpha;
 229   }
 230
 231   body dd {
 232     margin-left: 0;
 233   }
 234
 235   body code {
 236     font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
 237     font-size: 12px;
 238   }
 239
 240   body pre {
 241     margin-top: 0;
 242     margin-bottom: 0;
 243     font: 12px Consolas, "Liberation Mono", Menlo, Courier, monospace;
 244   }
 245
 246   body .select::-ms-expand {
 247     opacity: 0;
 248   }
 249
 250   body .octicon {
 251     font: normal normal normal 16px/1 octicons-link;
 252     display: inline-block;
 253     text-decoration: none;
 254     text-rendering: auto;
 255     -webkit-font-smoothing: antialiased;
 256     -moz-osx-font-smoothing: grayscale;
 257     -webkit-user-select: none;
 258     -moz-user-select: none;
 259     -ms-user-select: none;
 260     user-select: none;
 261   }
 262
 263   body .octicon-link:before {
 264     content: '\f05c';
 265   }
 266
 267   body:before {
 268     display: table;
 269     content: "";
 270   }
 271
 272   body:after {
 273     display: table;
 274     clear: both;
 275     content: "";
 276   }
 277
 278   body>*:first-child {
 279     margin-top: 0 !important;
 280   }
 281
 282   body>*:last-child {
 283     margin-bottom: 0 !important;
 284   }
 285
 286   body a:not([href]) {
 287     color: inherit;
 288     text-decoration: none;
 289   }
 290
 291   body .anchor {
 292     display: inline-block;
 293     padding-right: 2px;
 294     margin-left: -18px;
 295   }
 296
 297   body .anchor:focus {
 298     outline: none;
 299   }
 300
 301   body h1,
 302   body h2,
 303   body h3,
 304   body h4,
 305   body h5,
 306   body h6 {
 307     margin-top: 1em;
 308     margin-bottom: 16px;
 309     font-weight: bold;
 310     line-height: 1.4;
 311   }
 312
 313   body h1 .octicon-link,
 314   body h2 .octicon-link,
 315   body h3 .octicon-link,
 316   body h4 .octicon-link,
 317   body h5 .octicon-link,
 318   body h6 .octicon-link {
 319     color: #000;
 320     vertical-align: middle;
 321     visibility: hidden;
 322   }
 323
 324   body h1:hover .anchor,
 325   body h2:hover .anchor,
 326   body h3:hover .anchor,
 327   body h4:hover .anchor,
 328   body h5:hover .anchor,
 329   body h6:hover .anchor {
 330     text-decoration: none;
 331   }
 332
 333   body h1:hover .anchor .octicon-link,
 334   body h2:hover .anchor .octicon-link,
 335   body h3:hover .anchor .octicon-link,
 336   body h4:hover .anchor .octicon-link,
 337   body h5:hover .anchor .octicon-link,
 338   body h6:hover .anchor .octicon-link {
 339     visibility: visible;
 340   }
 341
 342   body h1 {
 343     padding-bottom: 0.3em;
 344     font-size: 1.75em;
 345     line-height: 1.2;
 346   }
 347
 348   body h1 .anchor {
 349     line-height: 1;
 350   }
 351
 352   body h2 {
 353     padding-bottom: 0.3em;
 354     font-size: 1.5em;
 355     line-height: 1.225;
 356   }
 357
 358   body h2 .anchor {
 359     line-height: 1;
 360   }
 361
 362   body h3 {
 363     font-size: 1.25em;
 364     line-height: 1.43;
 365   }
 366
 367   body h3 .anchor {
 368     line-height: 1.2;
 369   }
 370
 371   body h4 {
 372     font-size: 1em;
 373   }
 374
 375   body h4 .anchor {
 376     line-height: 1.2;
 377   }
 378
 379   body h5 {
 380     font-size: 1em;
 381   }
 382
 383   body h5 .anchor {
 384     line-height: 1.1;
 385   }
 386
 387   body h6 {
 388     font-size: 1em;
 389     color: #777;
 390   }
 391
 392   body h6 .anchor {
 393     line-height: 1.1;
 394   }
 395
 396   body p,
 397   body blockquote,
 398   body ul,
 399   body ol,
 400   body dl,
 401   body table,
 402   body pre {
 403     margin-top: 0;
 404     margin-bottom: 16px;
 405   }
 406
 407   body hr {
 408     height: 4px;
 409     padding: 0;
 410     margin: 16px 0;
 411     background-color: #e7e7e7;
 412     border: 0 none;
 413   }
 414
 415   body ul,
 416   body ol {
 417     padding-left: 2em;
 418   }
 419
 420   body ul ul,
 421   body ul ol,
 422   body ol ol,
 423   body ol ul {
 424     margin-top: 0;
 425     margin-bottom: 0;
 426   }
 427
 428   body li>p {
 429     margin-top: 16px;
 430   }
 431
 432   body dl {
 433     padding: 0;
 434   }
 435
 436   body dl dt {
 437     padding: 0;
 438     margin-top: 16px;
 439     font-size: 1em;
 440     font-style: italic;
 441     font-weight: bold;
 442   }
 443
 444   body dl dd {
 445     padding: 0 16px;
 446     margin-bottom: 16px;
 447   }
 448
 449   body blockquote {
 450     padding: 0 15px;
 451     color: #777;
 452     border-left: 4px solid #ddd;
 453   }
 454
 455   body blockquote>:first-child {
 456     margin-top: 0;
 457   }
 458
 459   body blockquote>:last-child {
 460     margin-bottom: 0;
 461   }
 462
 463   body table {
 464     display: block;
 465     width: 100%;
 466     overflow: auto;
 467     word-break: normal;
 468     word-break: keep-all;
 469   }
 470
 471   body table th {
 472     font-weight: bold;
 473   }
 474
 475   body table th,
 476   body table td {
 477     padding: 6px 13px;
 478     border: 1px solid #ddd;
 479   }
 480
 481   body table tr {
 482     background-color: #fff;
 483     border-top: 1px solid #ccc;
 484   }
 485
 486   body table tr:nth-child(2n) {
 487     background-color: #f8f8f8;
 488   }
 489
 490   body img {
 491     max-width: 100%;
 492     box-sizing: content-box;
 493     background-color: #fff;
 494   }
 495
 496   body code {
 497     padding: 0;
 498     padding-top: 0;
 499     padding-bottom: 0;
 500     margin: 0;
 501     font-size: 85%;
 502     background-color: rgba(0,0,0,0.04);
 503     border-radius: 3px;
 504   }
 505
 506   body code:before,
 507   body code:after {
 508     letter-spacing: -0.2em;
 509     content: "\00a0";
 510   }
 511
 512   body pre>code {
 513     padding: 0;
 514     margin: 0;
 515     font-size: 100%;
 516     word-break: normal;
 517     white-space: pre;
 518     background: transparent;
 519     border: 0;
 520   }
 521
 522   body .highlight {
 523     margin-bottom: 16px;
 524   }
 525
 526   body .highlight pre,
 527   body pre {
 528     padding: 16px;
 529     overflow: auto;
 530     font-size: 85%;
 531     line-height: 1.45;
 532     background-color: #f7f7f7;
 533     border-radius: 3px;
 534   }
 535
 536   body .highlight pre {
 537     margin-bottom: 0;
 538     word-break: normal;
 539   }
 540
 541   body pre {
 542     word-wrap: normal;
 543   }
 544
 545   body pre code {
 546     display: inline;
 547     max-width: initial;
 548     padding: 0;
 549     margin: 0;
 550     overflow: initial;
 551     line-height: inherit;
 552     word-wrap: normal;
 553     background-color: transparent;
 554     border: 0;
 555   }
 556
 557   body pre code:before,
 558   body pre code:after {
 559     content: normal;
 560   }
 561
 562   body kbd {
 563     display: inline-block;
 564     padding: 3px 5px;
 565     font-size: 11px;
 566     line-height: 10px;
 567     color: #555;
 568     vertical-align: middle;
 569     background-color: #fcfcfc;
 570     border: solid 1px #ccc;
 571     border-bottom-color: #bbb;
 572     border-radius: 3px;
 573     box-shadow: inset 0 -1px 0 #bbb;
 574   }
 575
 576   body .pl-c {
 577     color: #969896;
 578   }
 579
 580   body .pl-c1,
 581   body .pl-s .pl-v {
 582     color: #0086b3;
 583   }
 584
 585   body .pl-e,
 586   body .pl-en {
 587     color: #795da3;
 588   }
 589
 590   body .pl-s .pl-s1,
 591   body .pl-smi {
 592     color: #333;
 593   }
 594
 595   body .pl-ent {
 596     color: #63a35c;
 597   }
 598
 599   body .pl-k {
 600     color: #a71d5d;
 601   }
 602
 603   body .pl-pds,
 604   body .pl-s,
 605   body .pl-s .pl-pse .pl-s1,
 606   body .pl-sr,
 607   body .pl-sr .pl-cce,
 608   body .pl-sr .pl-sra,
 609   body .pl-sr .pl-sre {
 610     color: #183691;
 611   }
 612
 613   body .pl-v {
 614     color: #ed6a43;
 615   }
 616
 617   body .pl-id {
 618     color: #b52a1d;
 619   }
 620
 621   body .pl-ii {
 622     background-color: #b52a1d;
 623     color: #f8f8f8;
 624   }
 625
 626   body .pl-sr .pl-cce {
 627     color: #63a35c;
 628     font-weight: bold;
 629   }
 630
 631   body .pl-ml {
 632     color: #693a17;
 633   }
 634
 635   body .pl-mh,
 636   body .pl-mh .pl-en,
 637   body .pl-ms {
 638     color: #1d3e81;
 639     font-weight: bold;
 640   }
 641
 642   body .pl-mq {
 643     color: #008080;
 644   }
 645
 646   body .pl-mi {
 647     color: #333;
 648     font-style: italic;
 649   }
 650
 651   body .pl-mb {
 652     color: #333;
 653     font-weight: bold;
 654   }
 655
 656   body .pl-md {
 657     background-color: #ffecec;
 658     color: #bd2c00;
 659   }
 660
 661   body .pl-mi1 {
 662     background-color: #eaffea;
 663     color: #55a532;
 664   }
 665
 666   body .pl-mdr {
 667     color: #795da3;
 668     font-weight: bold;
 669   }
 670
 671   body .pl-mo {
 672     color: #1d3e81;
 673   }
 674
 675   body kbd {
 676     display: inline-block;
 677     padding: 3px 5px;
 678     font: 11px Consolas, "Liberation Mono", Menlo, Courier, monospace;
 679     line-height: 10px;
 680     color: #555;
 681     vertical-align: middle;
 682     background-color: #fcfcfc;
 683     border: solid 1px #ccc;
 684     border-bottom-color: #bbb;
 685     border-radius: 3px;
 686     box-shadow: inset 0 -1px 0 #bbb;
 687   }
 688
 689   body .task-list-item {
 690     list-style-type: none;
 691   }
 692
 693   body .task-list-item+.task-list-item {
 694     margin-top: 3px;
 695   }
 696
 697   body .task-list-item input {
 698     margin: 0 0.35em 0.25em -1.6em;
 699     vertical-align: middle;
 700   }
 701
 702   body :checked+.radio-label {
 703     z-index: 1;
 704     position: relative;
 705     border-color: #4078c0;
 706   }
 707   </style>
 708 </head>
 709 <body>
 710 <div id="TOC">
 711 <ul>
 712 <li><a href="#building-jalview-from-source">Building Jalview from Source</a><ul>
 713 <li><a href="#tldr">tl;dr</a></li>
 714 <li><a href="#setting-up">Setting up</a><ul>
 715 <li><a href="#java-11-compliant-jdk">Java 11 compliant JDK</a></li>
 716 <li><a href="#gradle-and-git">gradle and git</a></li>
 717 </ul></li>
 718 <li><a href="#downloading-the-jalview-source-tree">Downloading the Jalview source tree</a><ul>
 719 <li><a href="#whats-in-the-source-tree">What's in the source tree?</a></li>
 720 </ul></li>
 721 <li><a href="#building-jalview">Building Jalview</a><ul>
 722 <li><a href="#minimal-jalview-build">Minimal Jalview Build</a></li>
 723 <li><a href="#jalview-in-a-jar-file">Jalview in a Jar File</a></li>
 724 <li><a href="#distributed-jar-files">Distributed Jar Files</a></li>
 725 <li><a href="#single-shadow-jar-file">Single <em>shadow</em> Jar File</a></li>
 726 <li><a href="#building-the-getdown-launcher">Building the <code>getdown</code> launcher</a></li>
 727 <li><a href="#running-tests">Running tests</a></li>
 728 <li><a href="#installer-packaging-with-install4j">Installer packaging with <em>install4j</em></a></li>
 729 </ul></li>
 730 <li><a href="#gradle-properties">Gradle properties</a></li>
 731 <li><a href="#enabling-code-coverage-with-openclover">Enabling Code Coverage with OpenClover</a></li>
 732 <li><a href="#setting-up-in-eclipse-ide">Setting up in Eclipse IDE</a><ul>
 733 <li><a href="#installing-eclipse-ide">Installing Eclipse IDE</a></li>
 734 <li><a href="#importing-jalview-as-an-eclipse-project">Importing Jalview as an Eclipse project</a></li>
 735 </ul></li>
 736 </ul></li>
 737 </ul>
 738 </div>
 739 <h1 id="building-jalview-from-source">Building Jalview from Source</h1>
 740 <h2 id="tldr">tl;dr</h2>
 741 <pre><code># download
 742 git clone http://source.jalview.org/git/jalview.git
 743 # compile
 744 cd jalview
 745 gradle shadowJar
 746 # run
 747 java -jar build/libs/jalview-all-11.jar
 748
 749 # and/or create launcher
 750 gradle getdown
 751 # use launcher
 752 cd getdown/files
 753 java -jar getdown-launcher.jar . jalview</code></pre>
 754 <h2 id="setting-up">Setting up</h2>
 755 <blockquote>
 756 <p>To get set up using <em>only</em> the Eclipse IDE (<a href="https://www.eclipse.org/" class="uri">https://www.eclipse.org/</a>) then please see the section <a href="#setting-up-in-eclipse-ide">Setting up in Eclipse IDE</a></p>
 757 </blockquote>
 758 <p>The method here is described in terms of using a command line. You can easily do this on linux or in a Terminal window in macOS. You can do it in Windows.</p>
 759 <ul>
 760 <li>Java 11 compliant JDK</li>
 761 <li>gradle 5.2 or above</li>
 762 <li>git</li>
 763 </ul>
 764 <blockquote>
 765 <p>The versions and installation methods here are just suggestions (which we have tested so are known to work). If you need or wish to use different implementations (particularly you might need a bespoke JDK if you are on an exotic architecture) then the general build instructions should work with any gradle 5+. You should be able to compile the bytecode with any JDK Java 11+. The resulting bytecode (in particular the shadow jar) should be runnable in any JRE Java 1.8+. Remember that because Jalview and the getdown launcher are Java bytecode you can build on one system where you might have gradle, and run on another where you don't (JRE 1.8+ required).</p>
 766 </blockquote>
 767 <h3 id="java-11-compliant-jdk">Java 11 compliant JDK</h3>
 768 <h4 id="all-platforms">All platforms</h4>
 769 <p>We recommend obtaining an OpenJDK JDK 11 (since 11 is the long term support release) from AdoptOpenJDK: <a href="https://adoptopenjdk.net/?variant=openjdk11&amp;jvmVariant=hotspot" class="uri">https://adoptopenjdk.net/?variant=openjdk11&amp;jvmVariant=hotspot</a>, either the <em>Installer</em> or <code>.zip</code>/<code>.tar.gz</code> variants whichever you prefer (if you're not sure, choose the <em>Installer</em>).</p>
 770 <blockquote>
 771 <h5 id="alternativecli-install-of-adoptopenjdk-11">Alternative/CLI install of AdoptOpenJDK 11</h5>
 772 <p>You can also install adoptopenjdk11 using either <code>brew</code> (macOS), <code>choco</code> (Windows) (see the section on <code>gradle</code> and <code>git</code> for more informaiton on <code>brew</code> and <code>choco</code>) or <code>yum</code> or <code>apt</code> (Linux):</p>
 773 <h6 id="alternative-for-macos-and-homebrew">alternative for MacOS and Homebrew</h6>
 774 <pre><code>brew tap adoptopenjdk/openjdk
 775 brew cask install adoptopenjdk11</code></pre>
 776 <h6 id="alternative-for-windows-and-chocolatey">alternative for Windows and Chocolatey</h6>
 777 <pre><code>choco install adoptopenjdk11</code></pre>
 778 <h6 id="alternative-for-linux-with-yumapt">alternative for Linux with yum/apt</h6>
 779 <p>see <a href="https://adoptopenjdk.net/installation.html#linux-pkg" class="uri">https://adoptopenjdk.net/installation.html#linux-pkg</a></p>
 780 </blockquote>
 781 <h3 id="gradle-and-git">gradle and git</h3>
 782 <p>You should be able to install the latest (or sufficiently recent) versions of gradle and git using your OS package manager.</p>
 783 <h4 id="macos">MacOS</h4>
 784 <p>we recommend using <code>brew</code>, which can be installed following the instructions at <a href="https://brew.sh/" class="uri">https://brew.sh/</a>. After installing <code>brew</code>, open a Terminal window and type in (using an Administrator privileged user):</p>
 785 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="ex">brew</span> install gradle git</code></pre></div>
 786 <p>or if you aready have them installed but need to upgrade the version:</p>
 787 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="ex">brew</span> upgrade gradle git</code></pre></div>
 788 <h4 id="windows">Windows</h4>
 789 <p>we suggest using the <strong>Chocolatey</strong> package manager. See install instructions at <a href="https://chocolatey.org/" class="uri">https://chocolatey.org/</a>, and you will just need</p>
 790 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="ex">choco</span> install gradle
 791 <span class="ex">choco</span> install git</code></pre></div>
 792 <p>Alternatively, you could install a real <code>bash</code> shell and install both <code>gradle</code> and <code>git</code> through <code>apt-get</code>. See <a href="https://devblogs.microsoft.com/commandline/bash-on-ubuntu-on-windows-download-now-3/" class="uri">https://devblogs.microsoft.com/commandline/bash-on-ubuntu-on-windows-download-now-3/</a> for how to install the ubuntu bash shell in Windows 10.</p>
 793 <p>Another alternative would be to install them separately. For <code>gradle</code> follow the instructions at <a href="https://gradle.org/install/" class="uri">https://gradle.org/install/</a>, and for <code>git</code> here are a couple of suggestions: Git for Windows <a href="https://gitforwindows.org/" class="uri">https://gitforwindows.org/</a>. Getting the individual installs working together on the command line will be trickier so we recommend using Chocolatey or bash.</p>
 794 <h4 id="linux">Linux</h4>
 795 <p>this will depend on which distribution you're using.</p>
 796 <h5 id="for-debian-based-distributions-e.g.-mint-ubuntu-debian">For <em>Debian</em> based distributions (e.g. Mint, Ubuntu, Debian)</h5>
 797 <p>run</p>
 798 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"> <span class="fu">sudo</span> apt-get install gradle git</code></pre></div>
 799 <h5 id="for-rpm-based-distributions-e.g.-fedora-centos-redhat">for RPM-based distributions (e.g. Fedora, CentOS, RedHat)</h5>
 800 <p>run</p>
 801 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="fu">sudo</span> yum install gradle git</code></pre></div>
 802 <p>If you have some other version of linux you'll probably be able to work it out!</p>
 803 <h2 id="downloading-the-jalview-source-tree">Downloading the Jalview source tree</h2>
 804 <p>This can be done with <code>git</code>. On the command line, change directory to where you want to download Jalview's build-tree top level directory. Then run</p>
 805 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="fu">git</span> clone http://source.jalview.org/git/jalview.git</code></pre></div>
 806 <p>You'll get some progress output and after a minute or two you should have the full Jalview build-tree in the folder <code>jalview</code>.</p>
 807 <h3 id="whats-in-the-source-tree">What's in the source tree?</h3>
 808 <p>Jalview is a mature product with its codebase going back many years. As such it doesn't have a folder structure that most new gradle projects would have, so you might not find everything in the place you might expect. Here's a brief description of what you might find in the main folders under the <code>jalview</code> tree.</p>
 809 <p>Within the <code>jalview</code> folder you will find (of possible interest):</p>
 810 <table>
 811 <colgroup>
 812 <col width="16%" />
 813 <col width="83%" />
 814 </colgroup>
 815 <thead>
 816 <tr class="header">
 817 <th>dir/ or file</th>
 818 <th>contains</th>
 819 </tr>
 820 </thead>
 821 <tbody>
 822 <tr class="odd">
 823 <td><code>bin/</code></td>
 824 <td>used by eclipse for compiled classes -- no need to touch this</td>
 825 </tr>
 826 <tr class="even">
 827 <td><code>build/</code></td>
 828 <td>the gradle build dir</td>
 829 </tr>
 830 <tr class="odd">
 831 <td><code>classes/</code></td>
 832 <td>contains the compiled Java classes for the Jalview application</td>
 833 </tr>
 834 <tr class="even">
 835 <td><code>dist/</code></td>
 836 <td>assembled <code>.jar</code> files needed to run Jalview application</td>
 837 </tr>
 838 <tr class="odd">
 839 <td><code>examples/</code></td>
 840 <td>example input files usable by Jalview</td>
 841 </tr>
 842 <tr class="even">
 843 <td><code>getdown/</code></td>
 844 <td>the libraries used by the Javliew launcher (getdown)</td>
 845 </tr>
 846 <tr class="odd">
 847 <td><code>getdown/src/</code></td>
 848 <td>our modified source for <code>getdown</code></td>
 849 </tr>
 850 <tr class="even">
 851 <td><code>getdown/website/</code></td>
 852 <td>the assembled &quot;download&quot; folder used by getdown for downloads/upgrades</td>
 853 </tr>
 854 <tr class="odd">
 855 <td><code>getdown/files/</code></td>
 856 <td>the minimal fileset to launch the Jalview launcher, which can then download the rest of the Jalview application</td>
 857 </tr>
 858 <tr class="even">
 859 <td><code>help/</code></td>
 860 <td>the help documents</td>
 861 </tr>
 862 <tr class="odd">
 863 <td><code>j8lib/</code></td>
 864 <td>libraries needed to run Jalview under Java 1.8</td>
 865 </tr>
 866 <tr class="even">
 867 <td><code>j11lib/</code></td>
 868 <td>libraries needed to run Jalivew under Java 11</td>
 869 </tr>
 870 <tr class="odd">
 871 <td><code>resource/</code></td>
 872 <td>non-java resources used in the Jalview application</td>
 873 </tr>
 874 <tr class="even">
 875 <td><code>src/</code></td>
 876 <td>the Jalview application source <code>.java</code> files</td>
 877 </tr>
 878 <tr class="odd">
 879 <td><code>test/</code></td>
 880 <td>Test class source files</td>
 881 </tr>
 882 <tr class="even">
 883 <td><code>utils/</code></td>
 884 <td>helper applications used in the build process</td>
 885 </tr>
 886 <tr class="odd">
 887 <td><code>utils/install4j/</code></td>
 888 <td>files used by the packaging tool, install4j</td>
 889 </tr>
 890 <tr class="even">
 891 <td><code>build.gradle</code></td>
 892 <td>the build file used by gradle</td>
 893 </tr>
 894 <tr class="odd">
 895 <td><code>gradle.properties</code></td>
 896 <td>configurable properties for the build process</td>
 897 </tr>
 898 </tbody>
 899 </table>
 900 <p>Note that you need a Java 11 JDK to compile Jalview whether your target build is Java 1.8 or Java 11.</p>
 901 <h2 id="building-jalview">Building Jalview</h2>
 902 <p>You will need to have the Java 11 <code>javac</code> in your path, or alternatively you can configure gradle to know where this is by putting</p>
 903 <pre><code>org.gradle.java.home=/path_to_jdk_directory</code></pre>
 904 <p>in the <code>gradle.properties</code> file.</p>
 905 <blockquote>
 906 <p><em>You may want to see some of the other properties you can change at the end of this document.</em></p>
 907 </blockquote>
 908 <h3 id="minimal-jalview-build">Minimal Jalview Build</h3>
 909 <p>To compile the necessary class files, just run</p>
 910 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="ex">gradle</span> compileJava</code></pre></div>
 911 <p>to compile the classes into the <code>classes</code> folder. You should now be able to run the Jalview application directly with</p>
 912 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="ex">java</span> -cp <span class="st">&quot;classes:resources:help:j11lib/*&quot;</span> jalview.bin.Jalview</code></pre></div>
 913 <p>You can also run with an automatic large memory setting (which will set the maximum memory heap of the Jalview JVM to 90% of your local physical memory) and docked icon setting (if possible in your OS) with</p>
 914 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="ex">java</span> -cp <span class="st">&quot;classes:resources:help:j11lib/*&quot;</span> jalview.bin.Launcher</code></pre></div>
 915 <blockquote>
 916 <p><em>You must use just &quot;<code>j11lib/*</code>&quot; and not &quot;<code>j11lib/*.jar</code>&quot; as this is a special Java classpath argument wildcard interpreted by <code>java</code>, <strong>not</strong> a shell expansion wildcard interpreted by the shell.</em></p>
 917 </blockquote>
 918 <p>Note that <code>jalview.bin.Launcher</code> is a simplified launcher class that re-launches <code>jalview.bin.Jalview</code> with the same JRE (<em>not</em> the same JVM instance), classpath and arguments, but with an automatically determined <code>-Xmx...</code> memory setting if one hasn't been provided.</p>
 919 <h3 id="jalview-in-a-jar-file">Jalview in a Jar File</h3>
 920 <p>To package the <code>classes</code>, <code>resources</code>, and <code>help</code> into one jar, you can run</p>
 921 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="ex">gradle</span> jar</code></pre></div>
 922 <p>which assembles the Jalview classes and resources into <code>dist/jalview.jar</code></p>
 923 <p>To run this, use</p>
 924 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="ex">java</span> -cp <span class="st">&quot;dist/jalview.jar:j11lib/*&quot;</span> jalview.bin.Jalview</code></pre></div>
 925 <h3 id="distributed-jar-files">Distributed Jar Files</h3>
 926 <p>To simplify this, all required <code>.jar</code> files can be assembled into the <code>dist</code> folder using</p>
 927 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="ex">gradle</span> makeDist</code></pre></div>
 928 <p>which puts all required jar files into <code>dist</code> so you can run with</p>
 929 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="ex">java</span> -cp <span class="st">&quot;dist/*&quot;</span> jalview.bin.Jalview</code></pre></div>
 930 <h3 id="single-shadow-jar-file">Single <em>shadow</em> Jar File</h3>
 931 <p>The shadow jar file is a single <code>.jar</code> that contains all required classes and resources from <code>jalview.jar</code> and all of the supporting libraries in <code>j11lib/*.jar</code> merged into one <code>.jar</code> archive file. A default launching class (<code>MAIN-CLASS: jalview.bin.Launcher</code>) is specified in the <code>.jar</code> manifest file (<code>META/MANIFEST.MF</code>) so a start class doesn't need to be specified.</p>
 932 <p>Build the shadow jar file in <code>build/lib/jalview-all-11.jar</code> with</p>
 933 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="ex">gradle</span> shadowJar</code></pre></div>
 934 <p>and run it with</p>
 935 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="ex">java</span> -jar build/lib/jalview-all-11.jar</code></pre></div>
 936 <p>Because no arguments are required, most OSes will associate a <code>.jar</code> file with the <code>java</code> application (if this has been installed through the OS and not just a local unzip) as a <code>-jar</code> argument so you may find you can launch <code>jalview-all-11.jar</code> just by double-clicking on it)!</p>
 937 <blockquote>
 938 <p>The <code>shadowJar</code> task is not a requirement for any other task, so to build the shadow jar file you must specify the <code>shadowJar</code> task.</p>
 939 </blockquote>
 940 <blockquote>
 941 <p>The shadow jar file represents probably the simplest way to distribute the Jalview application to machines that already have a Java 11 installed, although without the many and compelling benefits of the <code>getdown</code> launcher.</p>
 942 </blockquote>
 943 <h3 id="building-the-getdown-launcher">Building the <code>getdown</code> launcher</h3>
 944 <p>We have made significant customisations to the <code>getdown</code> launcher which you can find in <code>getdown/src/getdown</code>.</p>
 945 <blockquote>
 946 <p>You don't need to build this afresh as the required <code>gradle-core.jar</code> and <code>gradle-launcher.jar</code> files are already distributed in <code>j11lib</code> and <code>getdown/lib</code> but if you want to, then you'll need a working Maven and also a Java 8 JDK. Ensure the Java 8 <code>javac</code> is forefront in your path and do</p>
 947 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="bu">cd</span> getdown/src/getdown
 948 <span class="ex">mvn</span> clean package -Dgetdown.host.whitelist=<span class="st">&quot;jalview.org,*.jalview.org&quot;</span></code></pre></div>
 949 <p>and you will find the required <code>.jar</code> files in <code>core/target/gradle-core-XXX.jar</code> and <code>launcher/target/gradle-launcher-XXX.jar</code>. The <code>gradle-core.jar</code> should then be copied to all three of the <code>j8lib</code>, <code>j11lib</code> and <code>getdown/lib</code> folders, whilst the <code>gradle-launcher.jar</code> only needs to be copied to <code>getdown/lib</code>.</p>
 950 <p>The <code>mvn</code> command should ideally include the <code>-Dgetdown.host.whitelist=*.jalview.org</code> setting. This, and the necessary file copying commands, can be found in <code>getdown/src/getdown/mvn_cmd</code>.</p>
 951 </blockquote>
 952 <p>To assemble Jalview with <code>getdown</code> use the following gradle task:</p>
 953 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="ex">gradle</span> getdown</code></pre></div>
 954 <p>This puts all the necessary files to launch Jalview with <code>getdown</code> into <code>getdown/website/11/</code>. This could be treated as the reference folder for <code>getdown</code>, which is where a getdown launcher will check to see if the Jalview application files it has are up to date, and download if they aren't or it simply doesn't have them.</p>
 955 <p>A minimal getdown-launcher can be found in <code>getdown/files/11/</code> which checks its up-to-date status with (the absolute path to) <code>getdown/website/11/</code>.</p>
 956 <p>This can be launched with</p>
 957 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="ex">java</span> -jar getdown/files/11/getdown-launcher.jar getdown/files/11/ jalview</code></pre></div>
 958 <blockquote>
 959 <p>We've already met the <code>-jar file.jar</code> arguments. The next argument is the working folder for getdown, and the final argument, &quot;<code>jalview</code>&quot;, is a getdown application id (only &quot;<code>jalview</code>&quot; is defined here).</p>
 960 </blockquote>
 961 <h3 id="running-tests">Running tests</h3>
 962 <p>There are substantial tests written for Jalview that use TestNG, which you can run with</p>
 963 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="ex">gradle</span> test</code></pre></div>
 964 <p>These normally take around 5 - 10 minutes to complete and outputs its full results into the <code>tests/</code> folder. A summary of results should appear in your console.</p>
 965 <p>You can run different defined groups of tests with</p>
 966 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="ex">gradle</span> test -PtestngGroups=Network</code></pre></div>
 967 <p>Available groups include Functional (default), Network, External.</p>
 968 <h4 id="excluding-some-tests">Excluding some tests</h4>
 969 <p>Some of Jalview's Functional tests don't pass reliably in all environments. We tag these tests with a group like 'Not-bamboo' to mark them for exclusion when we run tests as part of continuous integration.</p>
 970 <p>To exclude one or more groups of tests, add them as a comma separated list in testngExcludedGroups.</p>
 971 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="ex">gradle</span> test -PtestngExcludedGroups=Not-bamboo</code></pre></div>
 972 <h3 id="installer-packaging-with-install4j">Installer packaging with <em>install4j</em></h3>
 973 <p>Jalview is currently using <em>install4j</em> <a href="https://www.ej-technologies.com/products/install4j/overview.html" class="uri">https://www.ej-technologies.com/products/install4j/overview.html</a> as its installer packaging tool.</p>
 974 <p>If you have a licensed installation of <em>install4j</em> you can build Jalview installers by running</p>
 975 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="ex">gradle</span> installers</code></pre></div>
 976 <p>though you may need to fiddle with the <code>install4j</code> and <code>copyInstall4jTemplate</code> tasks in <code>build.gradle</code> file to point to your installation of <em>install4j</em> and also to bundled JREs if you want to bundle those into the installers.</p>
 977 <p>If you want more details, get in touch on our development mailing list <a href="mailto:jalview-dev@jalview.org">jalview-dev@jalview.org</a>. Sign up at <a href="http://www.compbio.dundee.ac.uk/mailman/listinfo/jalview-dev" class="uri">http://www.compbio.dundee.ac.uk/mailman/listinfo/jalview-dev</a>.</p>
 978 <h2 id="gradle-properties">Gradle properties</h2>
 979 <p>There are a lot of properties configured in <code>gradle.properties</code> which we strongly recommend being left as they are unless you have a specific problem with the build process.</p>
 980 <p>There are a few gradle properties you might want to set on the command line with the <code>-P</code> flag when building a version of Jalview with specific requirements:</p>
 981 <h4 id="java_version"><code>JAVA_VERSION</code></h4>
 982 <p>This changes the <em>target</em> java bytecode version &gt; NOTE that you will need to use a Java 11 (or greater) JDK Java compiler to build Jalview for any byte-code target version.</p>
 983 <p>Valid values are <code>11</code> and <code>1.8</code>.</p>
 984 <p>e.g.</p>
 985 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="ex">gradle</span> shadowJar -PJAVA_VERSION=1.8</code></pre></div>
 986 <p>When using <code>-PJAVA_VERSION=1.8</code> the libraries from <code>j8lib</code> (instead of <code>j11lib</code>) will be used in the compile<br />
 987 and runtime classpath and also used in the <code>makeDist</code> build step. Where a Java version of <code>11</code> is used in folder and file names, it will instead use <code>1.8</code>. Also if you are building installer packages with <em>install4j</em> the package builder will look for JRE 1.8 bundles to package in the installers.</p>
 988 <blockquote>
 989 <p>Note that continued development of Jalview will assume a Java 11+ runtime environment, the 2.11.0 release will run under a Java 1.8 JRE with a few minor features disabled.</p>
 990 </blockquote>
 991 <h4 id="channel"><code>CHANNEL</code></h4>
 992 <p>This changes the <code>appbase</code> setting in <code>getdown.txt</code> (<code>appbase</code> is where the getdown launcher looks to see if there's an updated file) to point to a particular Jalview channel or some other appropriate place to look for required files. If the selected channel type requires the getdown <code>appbase</code> to be a local directory on the filesystem (instead of a website URL) then a modified version of the <code>getdown-launcher.jar</code> will be used to allow this. The two versions of the <code>getdown-launcher.jar</code> can be found in <code>getdown/lib</code>. Some other variables used in the build process might also be set differently depending on the value of <code>CHANNEL</code> to allow smooth operation of getdown in the given context.</p>
 993 <p>There are several values of <code>CHANNEL</code> that can be chosen, with a default of <code>LOCAL</code>. Here's what they're for and what they do:</p>
 994 <ul>
 995 <li><code>LOCAL</code>: This is for running the compiled application from the development directory. It will set
 996 <ul>
 997 <li><code>appbase</code> as <code>file://PATH/TO/YOUR/DEVELOPMENT/getdown/files/JAVA_VERSION</code> (e.g. <code>file://home/user/git/jalview/getdown/files/11</code>)</li>
 998 <li>application subdir as <code>alt</code></li>
 999 <li>Getdown launcher can use a <code>file://</code> scheme appbase.</li>
1000 </ul></li>
1001 <li><code>BUILD</code>: This is for creating an appbase channel on the build server by an automatic or manually started build. It will set
1002 <ul>
1003 <li><code>appbase</code> as <code>https://builds.jalview.org/browse/${bamboo_planKey}/latest/artifact/shared/getdown-channel/JAVA_VERSION</code> Note that bamboo_planKey should be set by the build plan with <code>-Pbamboo_planKey=${bamboo.planKey}</code></li>
1004 <li>application subdir as <code>alt</code></li>
1005 <li>Getdown launcher cannot use a <code>file://</code> scheme appbase.</li>
1006 </ul></li>
1007 <li><code>DEVELOP</code>: This is for creating a <code>develop</code> appbase channel on the main web server. This won't become live until the actual getdown artefact is synced to the web server. It will set
1008 <ul>
1009 <li><code>appbase</code> as <code>http://www.jalview.org/getdown/develop/JAVA_VERSION</code></li>
1010 <li>application subdir as <code>alt</code></li>
1011 <li>Getdown launcher cannot use a <code>file://</code> scheme appbase.</li>
1012 </ul></li>
1013 <li><code>SCRATCH-NAME</code>: This is for creating a temporary scratch appbase channel on the main web server. This won't become live until the actual getdown artefact is synced to the web server. This is meant for testing an over-the-air update without interfering with the live <code>release</code> or <code>develop</code> channels. The value of <code>NAME</code> can be any &quot;word-character&quot; [A-Za-z0-9_] It will set
1014 <ul>
1015 <li><code>appbase</code> as <code>http://www.jalview.org/getdown/SCRATCH-NAME/JAVA_VERSION</code></li>
1016 <li>application subdir as <code>alt</code></li>
1017 <li>Getdown launcher cannot use a <code>file://</code> scheme appbase.</li>
1018 </ul></li>
1019 <li><code>TEST-LOCAL</code>: Like <code>SCRATCH</code> but with a specific <code>test-local</code> channel name and a local filesystem appbase. This is meant for testing an over-the-air update on the local filesystem. An extra property <code>LOCALDIR</code> must be given (e.g. <code>-PLOCALDIR=/home/user/tmp/test</code>) It will set
1020 <ul>
1021 <li><code>appbase</code> as <code>file://${LOCALDIR}</code></li>
1022 <li>application subdir as <code>alt</code></li>
1023 <li>Getdown launcher can use a <code>file://</code> scheme appbase.</li>
1024 </ul></li>
1025 <li><code>TEST-RELEASE</code>: Like <code>SCRATCH</code> but with a specific <code>test-release</code> channel name. This won't become live until the actual getdown artefact is synced to the web server. This is meant for testing an over-the-air update without interfering with the live <code>release</code> or <code>develop</code> channels. It will set
1026 <ul>
1027 <li><code>appbase</code> as <code>http://www.jalview.org/getdown/test-release/JAVA_VERSION</code></li>
1028 <li>application subdir as <code>alt</code></li>
1029 <li>Getdown launcher cannot use a <code>file://</code> scheme appbase.</li>
1030 </ul></li>
1031 <li><code>RELEASE</code>: This is for an actual release build, and will use an appbase on the main web server with the main <code>release</code> channel name. This won't become live until the actual getdown artefact is synced to the web server. It will set
1032 <ul>
1033 <li><code>appbase</code> as <code>http://www.jalview.org/getdown/release/JAVA_VERSION</code></li>
1034 <li>application subdir as <code>release</code></li>
1035 <li>Getdown launcher cannot use a <code>file://</code> scheme appbase.</li>
1036 </ul></li>
1037 <li><code>ARCHIVE</code>: This is a helper to create a channel for a specific release version, and will use an appbase on the main web server with a specific <code>archive/JALVIEW_VERSION</code> channel name. This won't become live until the actual getdown artefact is synced to the web server. You must also specify an <code>ARCHIVEDIR</code> property that points to an earlier version of Jalview with a <code>dist</code> directory containing the required jar files. This should create a getdown structure and digest with the older jar files. It will set
1038 <ul>
1039 <li><code>appbase</code> as <code>http://www.jalview.org/getdown/archive/JALVIEW_VERSION/JAVA_VERSION</code></li>
1040 <li>application subdir as <code>alt</code></li>
1041 <li>Getdown launcher cannot use a <code>file://</code> scheme appbase.</li>
1042 </ul></li>
1043 <li><code>ARCHIVELOCAL</code>: Like <code>ARCHIVE</code> but with a local filesystem appbase for local testing. You must also specify an <code>ARCHIVEDIR</code> property that points to an earlier version of Jalview with a <code>dist</code> directory containing the required jar files. This should create a getdown structure and digest with the older jar files. It will set
1044 <ul>
1045 <li><code>appbase</code> as <code>file://PATH/TO/YOUR/DEVELOPMENT/getdown/website/JAVA_VERSION</code> (where the old jars will have been copied and digested)</li>
1046 <li>application subdir as <code>alt</code></li>
1047 <li>Getdown launcher can use a <code>file://</code> scheme appbase.</li>
1048 </ul></li>
1049 </ul>
1050 <p>e.g.</p>
1051 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="ex">gradle</span> getdown -PCHANNEL=SCRATCH-my_test_version</code></pre></div>
1052 <h4 id="install4jmediatypes"><code>install4jMediaTypes</code></h4>
1053 <p>If you are building <em>install4j</em> installers (requires <em>install4j</em> to be installed) then this property specifies a comma-separated list of media types (i.e. platform specific installers) <em>install4j</em> should actually build.</p>
1054 <p>Currently the valid values are <code>linuxDeb</code>, <code>linuxRPM</code>, <code>macosArchive</code>, <code>unixArchive</code>, <code>unixInstaller</code>, <code>windows</code></p>
1055 <p>The default value is all of them.</p>
1056 <p>e.g.</p>
1057 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="ex">gradle</span> installers -PJAVA_VERSION=1.8 -Pinstall4jMediaTypes=macosArchive</code></pre></div>
1058 <p>To get an up-to-date list of possible values, you can run</p>
1059 <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="fu">perl</span> -n -e <span class="st">&#39;m/^\s*&lt;(\w+)[^&gt;]*\bmediaFileName=/ &amp;&amp; print &quot;$1\n&quot;;&#39;</span> utils/install4j/install4j_template.install4j  <span class="kw">|</span> <span class="fu">sort</span> -u</code></pre></div>
1060 <p>in the <code>jalview</code> root folder.</p>
1061 <h2 id="enabling-code-coverage-with-openclover">Enabling Code Coverage with OpenClover</h2>
1062 <p>Bytecode instrumentation tasks are enabled by specifying 'true' (or just a non-whitespace non-numeric word) in the 'clover' property. This adds the 'openclover' plugin to the build script's classpath, making it possible to track code execution during test which can be viewed as an HTML report published at build/reports/clover/index.html.</p>
1063 <p><code>gradle -Pclover=true test cloverReport</code></p>
1064 <h4 id="troubleshooting-report-generation">Troubleshooting report generation</h4>
1065 <p>The build forks a new JVM process to run the clover report generation tools (both XML and HTML reports are generated by default). The following properties can be used to specify additional options or adjust JVM memory settings. Default values for these options are:</p>
1066 <h5 id="jvm-memory-settings---increase-if-out-of-memory-errors-are-reported">JVM Memory settings - increase if out of memory errors are reported</h5>
1067 <p><code>cloverReportJVMHeap = 2g</code></p>
1068 <h5 id="dfile.encodingutf-8-is-an-essential-parameters-for-report-generation.-add-additional-ones-separated-by-a-space.">-Dfile.encoding=UTF-8 is an essential parameters for report generation. Add additional ones separated by a space.</h5>
1069 <p><code>cloverReportJVMArgs = -Dfile.encoding=UTF-8</code></p>
1070 <h5 id="add--v-to-debug-velocity-html-generation-errors-or--d-to-track-more-detailed-issues-with-the-coverage-database">Add -v to debug velocity html generation errors, or -d to track more detailed issues with the coverage database</h5>
1071 <p><code>cloverReportHTMLOptions =</code></p>
1072 <h5 id="v-for-verbose--d-for-debug-level-messages-as-above">-v for verbose, -d for debug level messages (as above)</h5>
1073 <p><code>cloverReportXMLOptions =</code></p>
1074 <p><em>Note</em> do not forget to include the -Dfile.encoding=UTF-8 option: this is essential for some platforms in order for Clover to correctly parse some Jalview source files that contain characters that are UTF-8 encoded.</p>
1075 <h2 id="setting-up-in-eclipse-ide">Setting up in Eclipse IDE</h2>
1076 <h3 id="installing-eclipse-ide">Installing Eclipse IDE</h3>
1077 <p>We develop in Eclipse, and support settings to develop and save Jalview source code in our preferred style. We also support running the Jalview application, debugging and running tests with TestNG from within Eclipse.</p>
1078 <p>To get Jalview set up as a project in Eclipse, we recommend using at least the 2019-12 version of Eclipse IDE for Java Developers which you can download from the Eclipse website: <a href="https://www.eclipse.org/downloads/" class="uri">https://www.eclipse.org/downloads/</a>. Since Eclipse 2020-03 you are encouraged to use the Eclipse Installer (see the Eclipse Downloads page). In the installer, when given a choice of packages for Eclipse you should choose the &quot;Eclipse IDE for Enterprise Java Developers&quot; package.</p>
1079 <div class="figure">
1080 <img src="./images/eclipse_installer.png" title="Eclipse Installer screenshot" />
1081
1082 </div>
1083 <p>Once Eclipse is installed, we also recommend installing several plugins from the Eclipse Marketplace.</p>
1084 <p>Some of these should already be installed with the Enterprise Java Developer package:</p>
1085 <ol style="list-style-type: decimal">
1086 <li>Buildship Gradle Integration 3.0 (or greater)</li>
1087 <li>EclEmma Java Code Coverage</li>
1088 <li>Egit - Git Integration for Eclipse</li>
1089 </ol>
1090 <p>To install the others, launch Eclipse, and go to Help-&gt;Eclipse Marketplace...</p>
1091 <p>Search for and install:</p>
1092 <ol style="list-style-type: decimal">
1093 <li>Groovy Development Tools 3.4.0 (or greater)</li>
1094 <li>Checkstyle Plug-in (optional)</li>
1095 <li>TestNG for Eclipse (optional -- only needed if you want to run tests from Eclipse)</li>
1096 </ol>
1097 <blockquote>
1098 <p>At time of writing, TestNG for Eclipse does not show up in the Eclipse Marketplace as the latest released version does not install in Eclipse 2019-03. However, you can install a working release of TestNG for Eclipse by going to</p>
1099 <p>Help-&gt;Install New Software...</p>
1100 <p>and entering</p>
1101 <p><code>TestNG Release - https://dl.bintray.com/testng-team/testng-eclipse-release</code></p>
1102 <p>into the <em>Work with</em> box and click on the <em>Add...</em> button.</p>
1103 <p>Eclipse might pause for a bit with the word <em>Pending</em> in the table below at this point, but it will eventually list TestNG with a selection box under the <em>Name</em> column.</p>
1104 <p>Select <em>TestNG</em> and carry on through the install process to install the TestNG plugin.</p>
1105 </blockquote>
1106 <p>After installing the plugins, check that Java 11 is set up in Eclipse as the default JRE (see section <a href="#java-11-compliant-jdk">Java 11 compliant JDK</a>).</p>
1107 <p>To do this go to Preferences (Eclipse-&gt;Preferences in macOS, File-&gt;Preferences on Windows or Window-&gt;Preferences on Linux) and find</p>
1108 <p>Java -&gt; Installed JREs</p>
1109 <p>If your Java 11 installation is not listed, click on</p>
1110 <p><em>Add</em> -&gt; Standard VM -&gt; <em>Next</em></p>
1111 <p>and enter the JRE home. You can browse to where it is installed. Give it a name (like &quot;AdoptOpenJDK 11&quot;). Select this JDK as the default JRE and click on <em>Apply and Close</em>.</p>
1112 <p>You can now import Jalview.</p>
1113 <h3 id="importing-jalview-as-an-eclipse-project">Importing Jalview as an Eclipse project</h3>
1114 <h4 id="importing-an-already-downloaded-git-repo">Importing an already downloaded git repo</h4>
1115 <p>If you have already downloaded Jalview using <code>git clone</code> then you can import this folder into Eclipse directly.</p>
1116 <p>It is important to import Jalview as a Gradle project (not as a Java project), so go to</p>
1117 <p>File-&gt;Import...</p>
1118 <p>find and select</p>
1119 <p>Gradle-&gt;Existing Gradle Project</p>
1120 <p>and then click on the <em>Next</em> button.</p>
1121 <p>In the following options, it is the <strong>Project Root Directory</strong> you should set to be the <code>jalview</code> folder that git downloaded. Then you can click on the <em>Finish</em> button.</p>
1122 <h4 id="using-eclipse-ide-to-download-the-git-repo">Using Eclipse IDE to download the git repo</h4>
1123 <p>If you don't have git as a command line tool or would prefer to work entirely within Eclipse IDE then Eclipse's eGit plugin can set up a git repo of the jalview source. Go to</p>
1124 <p>File-&gt;Import...</p>
1125 <p>Find and select</p>
1126 <p>Git-&gt;Projects from Git</p>
1127 <p>and then click on the <em>Next</em> button.</p>
1128 <p>Then select Clone URI and click on <em>Next</em>.</p>
1129 <p>In the next window (Source Git Repository) you should put the <code>git clone</code> URL in the text box labelled <code>URI</code>. If you have a Jalview developer account (with a username and password for the Jalview git repository) then you should enter <code>https://source.jalview.org/git/jalview.git</code>. If you do not have a Jalview developer account then you should enter <code>http://source.jalview.org/git/jalview.git</code>. You will not be able to push any of your changes back to the Jalview git repository. However you can still pull all branches of the Jalview source code to your computer and develop the code there. &gt; You can sign up for a Jalview developer account at <a href="https://source.jalview.org/crucible/" class="uri">https://source.jalview.org/crucible/</a></p>
1130 <p>If you have a Jalview developer account, enter the username and password and decide if you want to use Eclipse's secure storage. If you don't have an account you can leave the Authentication section blank.</p>
1131 <div class="figure">
1132 <img src="./images/eclipse_egit_connection.png" alt="Eclipse eGit connection configuration" />
1133 <p class="caption">Eclipse eGit connection configuration</p>
1134 </div>
1135 <p>Click on the <em>Next</em> button.</p>
1136 <p>The next window (Branch Selection) gives a list of the many Jalview branches, which by default will be all checked. You probably only want to download one branch (you can always download others at a later time). This is likely to be the <code>develop</code> branch so you can click on the <em>Deselect All</em> button, find the <code>develop</code> branch (the filter text helps), select that, and then click on the <em>Next</em> button.</p>
1137 <p>Choose a directory to your copy of the git repo in, and leave the other options as they are and click on the <em>Next</em> button. The next stage may take a minute or two as it checks out the selected branch(es) from the Jalview git repository.</p>
1138 <p>When it has finished it is important to select <strong>Import as general project</strong> and then click on <em>Next</em>. &gt; Ideally there would be an <em>Import as gradle project</em> here but there isn't -- we'll sort that out later.</p>
1139 <div class="figure">
1140 <img src="./images/eclipse_egit_import.png" alt="Eclipse eGit import choice" />
1141 <p class="caption">Eclipse eGit import choice</p>
1142 </div>
1143 <p>Click on the <em>Next</em> button.</p>
1144 <p>You can change the project name here. By default it will show as <strong>jalview</strong> which is fine unless you have another instance of the a Jalview project also called jalview, in which case you could change this project's name now to avoid a conflict within Eclipse.</p>
1145 <p>Click on <em>Finish</em>!</p>
1146 <p>However, we haven't finished...</p>
1147 <p>You should now see, and be able to expand, the jalview project in the Project Explorer. We need to tell eclipse that this is a Gradle project, which will then allow the Eclipse Buildship plugin to automatically configure almost everything else!</p>
1148 <p>Right click on the project name (jalview) in the Project Explorer and find Configure towards the bottom of this long context menu, then choose Add Gradle Nature.</p>
1149 <div class="figure">
1150 <img src="./images/eclipse_add_gradle_nature.png" alt="Eclipse Add Gradle Nature" />
1151 <p class="caption">Eclipse Add Gradle Nature</p>
1152 </div>
1153 <p>The project should now reconfigure itself using the <code>build.gradle</code> file to dynamically set various aspects of the project including classpath.</p>
1154 <h4 id="additional-views">Additional views</h4>
1155 <p>Some views that are automatically added when Importing a Gradle Project are not added when simply Adding a Gradle Nature, but we can add these manually by clicking on Window-&gt;Show View-&gt;Console and Window-&gt;Show View-&gt;Other... Filter with the word &quot;gradle&quot; and choose both <strong>Gradle Executions</strong> and <strong>Gradle Tasks</strong> and then click on the <em>Open</em> button.</p>
1156 <p>Okay, ready to code! Use of Eclipse is beyond the scope of this document, but you can find more information about developing jalview and our developer workflow in the google doc <a href="https://docs.google.com/document/d/1lZo_pZRkazDBJGNachXr6qCVlw8ByuMYG6e9SZlPUlQ/edit?usp=sharing" class="uri">https://docs.google.com/document/d/1lZo_pZRkazDBJGNachXr6qCVlw8ByuMYG6e9SZlPUlQ/edit?usp=sharing</a></p>
1157 <hr />
1158 <p><a href="mailto:help@jalview.org">Jalview Development Team</a></p>
1159 </body>
1160 </html>