| Apache Airavata Source - README.txt |
| Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 |
| -------------------------------------------------------------------------------- |
| |
| About |
| ===== |
| Apache Airavata is a micro-service architecture based software framework for executing and managing computational jobs |
| and workflows on distributed computing resources including local clusters, supercomputers, national grids, academic and |
| commercial clouds. Airavata is dominantly used to build Web-based science gateways and assist to compose, manage, |
| execute, and monitor large scale applications (wrapped as Web services) and workflows composed of these services. |
| |
| Contact |
| ======== |
| For additional information about Apache Airavata, please contact the user or dev mailing lists: |
| http://airavata.apache.org/community/mailing-lists.html |
| |
| Description of Airavata Directory Structure |
| ================================== |
| - airavata-api |
| This directory contains Airavata API related data models, api methods, generated server skeletons, client stubs, server implementations and client samples. |
| |
| - modules |
| This contains the source code of all the airavata maven projects organized as libraries, services and distributions |
| |
| - samples |
| This contains all the system wide samples provided in Airavata distribution. All the sample are having its README file |
| So users have to refer each readme file before running each sample. |
| |
| - tools |
| This contains source code libraries that can enhance Airavata features. |
| |
| - README |
| This document. |
| |
| - RELEASE_NOTES |
| The describe the key features and know issues with the current release. |
| |
| - INSTALL |
| This document will contain information on installing Apache-Airavata. |
| |
| Airavata Source Distribution Directory Structure |
| ================================================ |
| |
| AIRAVATA_TRUNK |
| ├── modules |
| │ ├── airavata-client |
| │ ├── commons |
| │ │ ├── gfac-schema |
| │ │ ├── utils |
| │ │ ├── workflow-execution-context |
| │ │ └── workflow-tracking |
| │ ├── distribution |
| │ │ ├── airavata-client |
| │ │ ├── airavata-server |
| │ │ ├── xbaya-gui |
| │ │ └── release |
| │ ├── gfac-core |
| │ ├── integration-tests |
| │ ├── registry |
| │ │ ├── airavata-jpa-registry |
| │ │ ├── airavata-registry-service |
| │ │ ├── airavata-registry-test |
| │ │ ├── registry-api |
| │ ├── rest |
| │ │ ├── client |
| │ │ ├── mappings |
| │ │ ├── service |
| │ │ └── webapp |
| │ ├── security |
| │ ├── credential-store |
| │ ├── server |
| │ ├── test-suite |
| │ ├── workflow-interpreter |
| │ ├── workflow-model |
| │ │ ├── workflow-model-component-node |
| │ │ └── workflow-model-core |
| │ ├── ws-messenger |
| │ │ ├── commons |
| │ │ ├── distribution |
| │ │ ├── messagebox |
| │ │ ├── messagebroker |
| │ │ ├── message-monitor |
| │ │ └── samples |
| │ └── xbaya-gui |
| ├── samples |
| ├── tools |
| │ ├── phoebus-integration |
| │ └── registry-migrate |
| ├── INSTALL |
| ├── LICENSE |
| ├── NOTICE |
| ├── README |
| └── RELEASE_NOTES |
| |
| Available Binary Distributions |
| ============================== |
| |
| Server Distributions |
| -------------------- |
| * Airavata Server |
| The Airavata Server binary distribution allows you to run a standalone Airavata Server which includes all the airavata services |
| shipped with a default derby database as the backend registry. For stable purposes, a mysql configuration is recommended. |
| |
| Client Distributions |
| -------------------- |
| |
| * Airavata Client |
| The Airavata Client distribution is a set of libraries and configurations files that allow a 3rd party application to |
| programatically access Airavata functionality through Airavata API. |
| |
| How to test and run samples |
| =========================== |
| * If you built Airavata from source, and if you see "BUILD SUCCESS", then the test cases should have passes. |
| * The test cases are beyond unit level, they startup embedded services and run through basic workflow use cases. |
| * To walk through Airavata features, follow "Airavata in Five Minutes" tutorial at http://airavata.apache.org/documentation/tutorials/airavata-in-5-minutes.html. |
| * For intermediate level Airavata features, follow "Airavata in Ten Minutes" tutorial at http://airavata.apache.org/documentation/tutorials/airavata-in-5-minutes.html. |
| * For advanced use cases, please contact mailing lists - http://airavata.apache.org/community/mailing-lists.html |
