layout: default title: Development id: development
<main>
<div class="container">
<div class="row">
<div class="col s12 m9 l10 push-m3 push-l2">
<div id="downloads" class="section scrollspy">
<h2 class="header">Downloads</h2>
<p>All downloads can be verified using the Apache Airavata code signing <a
href="{{ site.data.releases.keys }}">KEYS</a>.</p>
<h5 id="latest-release">{{ site.data.releases.latest.version }} (Latest Release)</h5>
<ol>
<li>
<p><a href="{{ site.data.releases.latest.release_note }}">Release Notes</a></p>
</li>
<li>
<strong>Source:</strong>
<a href="{{ site.data.releases.latest.src.link }}">{{ site.data.releases.latest.src.name
}}</a> [<a href="{{ site.data.releases.latest.src.asc }}">PGP signature</a>] [<a
href="{{ site.data.releases.latest.src.sha512 }}">checksum</a>]
</li>
<li>
<p><strong>Binary: </strong></p>
</li>
<ol>
<li>
<a href="{{ site.data.releases.latest.bin.tar_link }}">{{
site.data.releases.latest.bin.tar_name }}</a> [<a
href="{{ site.data.releases.latest.bin.tar_asc }}">PGP signature</a>] [<a
href="{{ site.data.releases.latest.bin.tar_sha512 }}">checksum</a>]
</li>
<li>
<a href="{{ site.data.releases.latest.bin.zip_link }}">{{
site.data.releases.latest.bin.zip_name }}</a> [<a
href="{{ site.data.releases.latest.bin.zip_asc }}">PGP signature</a>] [<a
href="{{ site.data.releases.latest.bin.zip_sha512 }}">checksum</a>]
</li>
</ol>
</ol>
<h3>Previous Releases</h3>
<p id="previous-releases-are-available-from-release-archive">
Previous releases are available from
<a href="{{ site.data.releases.previous_relases }}">Release Archive</a>. We encourage users
and developers to upgrade to the current release.
</p>
</div>
<div id="issue" class="section scrollspy">
<h2 class="header">Issue Tracker</h2>
<p>
Apache Airavata uses Atlassian JIRA as the official issue tracker. All Apache project issues
are publicly available for anyone to view. Accounts are required to post issues, but
anyone can create an account.
</p>
<p>
Issue Tracker Link : <a
href="https://issues.apache.org/jira/browse/airavata/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel"
target="_blank">https://issues.apache.org/jira/browse/airavata/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel</a>
</p>
</div>
<div id="tools" class="section scrollspy">
<h2 class="header">Development Tools</h2>
<h3>Release Management</h3>
<p>
Step by Step release menagement instructions are documented at <a
href="https://cwiki.apache.org/confluence/display/AIRAVATA/Apache+Airavata+Release+Management" target="_blank">Airavata CWiki Release Instructions</a>.
</p>
<h3>Profiling and Performance</h3>
<p>
Airavata developers use <a
href="http://www.ej-technologies.com/products/jprofiler/overview.html" target="_blank">JProfiler</a>
for code profiling and testing, and acknowledges free developer licenses provided by
ej-technologies.
</p>
<h3>Code Analysis</h3>
<p>
Airavata uses <a href="http://www.sonarqube.org/" target="_blank">Sonar</a> code analysis
tools. Sonar is an open source quality management platform, dedicated to continuously
analyze and measure technical quality, from the project portfolio to the class method.
</p>
<p>
Browse Airavata <a href="https://analysis.apache.org/" target="_blank">Sonar Dashboard</a>.
</p>
<h3>Continous Integration</h3>
<p>
Airavata uses <a href="https://jenkins.io/index.html" target="_blank">Jenkins Continous
Integration</a> for automatic builds. The builds are triggered automatically on code commits
and periodically.
</p>
<p>
Browse Airavata Jenkins Dashboard.
</p>
<h3>Code Review</h3>
<p>
Airavata uses <a href="https://www.reviewboard.org/" target="_blank">Review Board</a> for
pre and post commit reviews.
Browse <a href="https://reviews.apache.org/groups/Airavata/" target="_blank">Airavata
Reviews</a>. To submit or view reviews, you will need to create an account on <a
href="https://reviews.apache.org/r/" target="_blank">Apache Reviews</a>. Detailed
documentation on using the review tools is at <a
href="https://www.reviewboard.org/docs/manual/1.5/users/" target="_blank">Review Board
Documentation</a>.
</p>
</div>
<div id="source" class="section scrollspy">
<h2 class="header">Source Code</h2>
<p>The Apache Airavata source repositories are maintained using GIT version control. The repositories are mirrored in GitHub and are writable.
For practicle purposes contributors and committers can use these repositories as yet another github repo. All user level github documentations applies. Some admin funcations on github may not work and Apache INFRA needs to be contacted for help with these tasks. </p>
<p>Browse Airavata source repository on web: <a
href="https://git-wip-us.apache.org/repos/asf?p=airavata.git">https://git-wip-us.apache.org/repos/asf?p=airavata.git</a>.
</p>
<h3>Airavata Core Services</h3>
<ol>
<li>
<p><a href="https://github.com/apache/airavata.git">https://github.com/apache/airavata.git</a></p>
</li>
</ol>
<h3>Airavata PHP Gateway</h3>
<ol>
<li>
<p><a href="https://github.com/apache/airavata-php-gateway.git">https://github.com/apache/airavata-php=gateway.git</a></p>
</li>
</ol>
<h3>Airavata Documentation</h3>
<ol>
<li>
<p><a href="https://github.com/apache/airavata-docs.git">https://github.com/apache/airavata-docs.git</a></p>
</li>
</ol>
<h3>Airavata Web Site</h3>
<p>The Apache Airavata website is available from Apache's Git repository and mirrored in
GitHub.</p>
<ol>
<li>
<p><a href="https://github.com/apache/airavata-site">https://github.com/apache/airavata-site</a></p>
</li>
</ol>
</div>
<div id="build" class="section scrollspy">
<h2>Building the Code</h2>
The following instructions will build and deploy Apache Airavata for testing and development.
For a full, production environment gateway deployment, see <a
href="http://airavata.readthedocs.io/en/latest/">http://airavata.readthedocs.io/en/latest/</a>.
<h3> Prerequisites </h3>
<ol>
<li>Sources compilation require Java SE 8 or higher.</li>
<li> The project is built with Apache Maven 3+ [Download][1] and [install][2] (Maven 2.x
build will start but fail with errors)
</li>
<li> Set or export JAVA_HOME to point to JDK. For example in Ubuntu: export
JAVA_HOME=/usr/lib/jvm/java-6-openjdk
</li>
<li> Get Airavata source [checked out](source.html) from Airavata trunk.</li>
</ol>
<h3> Build the distribution </h3>
<ol>
<li>cd airavata-trunk</li>
<li> mvn clean install</li>
<li>To build without running tests, use mvn clean install -Dmaven.test.skip=true.</li>
<li>The compressed binary distribution is created at
PROJECT_DIR/modules/distribution/target
</li>
</ol>
</div>
<div id="develop" class="section scrollspy">
<h2>Developers Guide</h2>
<h3>Some coding practices:</h3>
<ol>
<li>License Header: Always add the current ASF license header as described in <a
href="http://www.apache.org/legal/src-headers.html">ASF Source Header</a>.
</li>
<li>Trailing Whitespaces: Remove all trailing whitespaces. Eclipse users can use Source->Cleanup
option to accomplish this.
</li>
<li>Indentation: Use 4 space indents and never use tabs!</li>
<li>Line wrapping: Use 120-column line width for Java code and Javadoc.</li>
<li>Author Tags: Do not use Author Tags. The code is developed and owned by the community.
</li>
</ol>
</div>
<div id="license" class="section scrollspy">
<h2 class="header">License</h2>
<p>Apache License<br><br>Version 2.0, January 2004<br><br>
<a href="http://www.apache.org/licenses/">http://www.apache.org/licenses/</a>
</p>
<p>TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION</p>
<p><strong><a name="definitions">1. Definitions</a></strong>.</p>
<p>"License" shall mean the terms and conditions for use, reproduction, and
distribution as defined by Sections 1 through 9 of this document.</p>
<p>"Licensor" shall mean the copyright owner or entity authorized by the
copyright owner that is granting the License.</p>
<p>"Legal Entity" shall mean the union of the acting entity and all other
entities that control, are controlled by, or are under common control with
that entity. For the purposes of this definition, "control" means (i) the
power, direct or indirect, to cause the direction or management of such
entity, whether by contract or otherwise, or (ii) ownership of fifty
percent (50%) or more of the outstanding shares, or (iii) beneficial
ownership of such entity.</p>
<p>"You" (or "Your") shall mean an individual or Legal Entity exercising
permissions granted by this License.</p>
<p>"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation source,
and configuration files.</p>
<p>"Object" form shall mean any form resulting from mechanical transformation
or translation of a Source form, including but not limited to compiled
object code, generated documentation, and conversions to other media types.</p>
<p>"Work" shall mean the work of authorship, whether in Source or Object form,
made available under the License, as indicated by a copyright notice that
is included in or attached to the work (an example is provided in the
Appendix below).</p>
<p>"Derivative Works" shall mean any work, whether in Source or Object form,
that is based on (or derived from) the Work and for which the editorial
revisions, annotations, elaborations, or other modifications represent, as
a whole, an original work of authorship. For the purposes of this License,
Derivative Works shall not include works that remain separable from, or
merely link (or bind by name) to the interfaces of, the Work and Derivative
Works thereof.</p>
<p>"Contribution" shall mean any work of authorship, including the original
version of the Work and any modifications or additions to that Work or
Derivative Works thereof, that is intentionally submitted to Licensor for
inclusion in the Work by the copyright owner or by an individual or Legal
Entity authorized to submit on behalf of the copyright owner. For the
purposes of this definition, "submitted" means any form of electronic,
verbal, or written communication sent to the Licensor or its
representatives, including but not limited to communication on electronic
mailing lists, source code control systems, and issue tracking systems that
are managed by, or on behalf of, the Licensor for the purpose of discussing
and improving the Work, but excluding communication that is conspicuously
marked or otherwise designated in writing by the copyright owner as "Not a
Contribution."</p>
<p>"Contributor" shall mean Licensor and any individual or Legal Entity on
behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.</p>
<p><strong><a name="copyright">2. Grant of Copyright License</a></strong>. Subject to the
terms and conditions of this License, each Contributor hereby grants to You
a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of, publicly
display, publicly perform, sublicense, and distribute the Work and such
Derivative Works in Source or Object form.</p>
<p><strong><a name="patent">3. Grant of Patent License</a></strong>. Subject to the terms
and conditions of this License, each Contributor hereby grants to You a
perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made, use,
offer to sell, sell, import, and otherwise transfer the Work, where such
license applies only to those patent claims licensable by such Contributor
that are necessarily infringed by their Contribution(s) alone or by
combination of their Contribution(s) with the Work to which such
Contribution(s) was submitted. If You institute patent litigation against
any entity (including a cross-claim or counterclaim in a lawsuit) alleging
that the Work or a Contribution incorporated within the Work constitutes
direct or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate as of the
date such litigation is filed.</p>
<p><strong><a name="redistribution">4. Redistribution</a></strong>. You may reproduce and
distribute copies of the Work or Derivative Works thereof in any medium,
with or without modifications, and in Source or Object form, provided that
You meet the following conditions:</p>
<ol>
<li>
<p>You must give any other recipients of the Work or Derivative Works a
copy of this License; and</p>
</li>
<li>
<p>You must cause any modified files to carry prominent notices stating
that You changed the files; and</p>
</li>
<li>
<p>You must retain, in the Source form of any Derivative Works that You
distribute, all copyright, patent, trademark, and attribution notices from
the Source form of the Work, excluding those notices that do not pertain to
any part of the Derivative Works; and</p>
</li>
<li>
<p>If the Work includes a "NOTICE" text file as part of its distribution,
then any Derivative Works that You distribute must include a readable copy
of the attribution notices contained within such NOTICE file, excluding
those notices that do not pertain to any part of the Derivative Works, in
at least one of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or documentation,
if provided along with the Derivative Works; or, within a display generated
by the Derivative Works, if and wherever such third-party notices normally
appear. The contents of the NOTICE file are for informational purposes only
and do not modify the License. You may add Your own attribution notices
within Derivative Works that You distribute, alongside or as an addendum to
the NOTICE text from the Work, provided that such additional attribution
notices cannot be construed as modifying the License.
You may add Your own copyright statement to Your modifications and may
provide additional or different license terms and conditions for use,
reproduction, or distribution of Your modifications, or for any such
Derivative Works as a whole, provided Your use, reproduction, and
distribution of the Work otherwise complies with the conditions stated in
this License.</p>
</li>
</ol>
<p><strong><a name="contributions">5. Submission of Contributions</a></strong>. Unless You
explicitly state otherwise, any Contribution intentionally submitted for
inclusion in the Work by You to the Licensor shall be under the terms and
conditions of this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify the
terms of any separate license agreement you may have executed with Licensor
regarding such Contributions.</p>
<p><strong><a name="trademarks">6. Trademarks</a></strong>. This License does not grant
permission to use the trade names, trademarks, service marks, or product
names of the Licensor, except as required for reasonable and customary use
in describing the origin of the Work and reproducing the content of the
NOTICE file.</p>
<p><strong><a name="no-warranty">7. Disclaimer of Warranty</a></strong>. Unless required by
applicable law or agreed to in writing, Licensor provides the Work (and
each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including,
without limitation, any warranties or conditions of TITLE,
NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You
are solely responsible for determining the appropriateness of using or
redistributing the Work and assume any risks associated with Your exercise
of permissions under this License.</p>
<p><strong><a name="no-liability">8. Limitation of Liability</a></strong>. In no event and
under no legal theory, whether in tort (including negligence), contract, or
otherwise, unless required by applicable law (such as deliberate and
grossly negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a result
of this License or out of the use or inability to use the Work (including
but not limited to damages for loss of goodwill, work stoppage, computer
failure or malfunction, or any and all other commercial damages or losses),
even if such Contributor has been advised of the possibility of such
damages.</p>
<p><strong><a name="additional">9. Accepting Warranty or Additional Liability</a></strong>.
While redistributing the Work or Derivative Works thereof, You may choose
to offer, and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this License.
However, in accepting such obligations, You may act only on Your own behalf
and on Your sole responsibility, not on behalf of any other Contributor,
and only if You agree to indemnify, defend, and hold each Contributor
harmless for any liability incurred by, or claims asserted against, such
Contributor by reason of your accepting any such warranty or additional
liability.</p>
<p>END OF TERMS AND CONDITIONS</p>
<h3 id="apply">APPENDIX: How to apply the Apache License to your work</h3>
<p>To apply the Apache License to your work, attach the following boilerplate
notice, with the fields enclosed by brackets "[]" replaced with your own
identifying information. (Don't include the brackets!) The text should be
enclosed in the appropriate comment syntax for the file format. We also
recommend that a file or class name and description of purpose be included
on the same "printed page" as the copyright notice for easier
identification within third-party archives.</p>
<div class="codehilite">
<pre>
<span class="p">:::</span><span class="n">text</span>
<span class="n">Copyright</span> <span class="p">[</span><span class="n">yyyy</span><span
class="p">]</span> <span class="p">[</span><span class="n">name</span> <span
class="n">of</span> <span class="n">copyright</span> <span class="n">owner</span><span
class="p">]</span>
<span class="n">Licensed</span> <span class="n">under</span> <span class="n">the</span> <span
class="n">Apache</span> <span class="n">License</span><span class="p">,</span> <span
class="n">Version</span> 2<span class="p">.</span>0 <span class="p">(</span><span class="n">the</span> "<span
class="n">License</span>"<span class="p">);</span>
<span class="n">you</span> <span class="n">may</span> <span class="n">not</span> <span class="n">use</span> <span
class="n">this</span> <span class="n">file</span> <span class="n">except</span> <span
class="n">in</span> <span class="n">compliance</span> <span class="n">with</span> <span
class="n">the</span> <span class="n">License</span><span class="p">.</span>
<span class="n">You</span> <span class="n">may</span> <span class="n">obtain</span> <span
class="n">a</span> <span class="n">copy</span> <span class="n">of</span> <span
class="n">the</span> <span class="n">License</span> <span class="n">at</span>
<span class="n">http</span><span class="p">:</span><span class="o">//</span><span
class="n">www</span><span class="p">.</span><span class="n">apache</span><span
class="p">.</span><span class="n">org</span><span class="o">/</span><span
class="n">licenses</span><span class="o">/</span><span class="n">LICENSE</span><span
class="o">-</span>2<span class="p">.</span>0
<span class="n">Unless</span> <span class="n">required</span> <span class="n">by</span> <span
class="n">applicable</span> <span class="n">law</span> <span class="n">or</span> <span
class="n">agreed</span> <span class="n">to</span> <span class="n">in</span> <span class="n">writing</span><span
class="p">,</span> <span class="n">software</span>
<span class="n">distributed</span> <span class="n">under</span> <span class="n">the</span> <span
class="n">License</span> <span class="n">is</span> <span class="n">distributed</span> <span
class="n">on</span> <span class="n">an</span> "<span class="n">AS</span> <span
class="n">IS</span>" <span class="n">BASIS</span><span class="p">,</span>
<span class="n">WITHOUT</span> <span class="n">WARRANTIES</span> <span class="n">OR</span> <span
class="n">CONDITIONS</span> <span class="n">OF</span> <span class="n">ANY</span> <span
class="n">KIND</span><span class="p">,</span> <span class="n">either</span> <span class="n">express</span> <span
class="n">or</span> <span class="n">implied</span><span class="p">.</span>
<span class="n">See</span> <span class="n">the</span> <span class="n">License</span> <span
class="k">for</span> <span class="n">the</span> <span class="n">specific</span> <span
class="n">language</span> <span class="n">governing</span> <span
class="n">permissions</span> <span class="n">and</span>
<span class="n">limitations</span> <span class="n">under</span> <span class="n">the</span> <span
class="n">License</span><span class="p">.</span>
</pre>
</div>
</div>
</div>
<div class="col hide-on-small-only m3 l2 pull-m9 pull-l10">
<div class="toc-wrapper pinned">
<div style="height: 1px;">
<ul class="section table-of-contents">
<li><a href="#downloads">Downloads</a></li>
<li><a href="#issue">Issue Tracker</a></li>
<li><a href="#tools">Dev Tools</a></li>
<li><a href="#source">Source Code</a></li>
<li><a href="#build">Build</a></li>
<li><a href="#develop">Develop</a></li>
<li><a href="#license">License</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
</main>