You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airavata.apache.org by er...@apache.org on 2022/07/10 19:22:45 UTC
[airavata-admin-user-docs] branch main updated: Adding gateway admin documentation for tutorial
This is an automated email from the ASF dual-hosted git repository.
eroma pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airavata-admin-user-docs.git
The following commit(s) were added to refs/heads/main by this push:
new a4af553 Adding gateway admin documentation for tutorial
a4af553 is described below
commit a4af55364c370814f0c5774f78c4b9ad4397b6fa
Author: eroma2014 <er...@gmail.com>
AuthorDate: Sun Jul 10 15:22:35 2022 -0400
Adding gateway admin documentation for tutorial
---
docs/img/appcatalog.png | Bin 0 -> 342362 bytes
docs/img/detectcovidexp.png | Bin 0 -> 247414 bytes
docs/img/detectcovidinput.png | Bin 0 -> 194450 bytes
docs/user-documentation/tutorials.md | 82 ++++++++++++++++++++++++-----------
4 files changed, 56 insertions(+), 26 deletions(-)
diff --git a/docs/img/appcatalog.png b/docs/img/appcatalog.png
new file mode 100644
index 0000000..f961a54
Binary files /dev/null and b/docs/img/appcatalog.png differ
diff --git a/docs/img/detectcovidexp.png b/docs/img/detectcovidexp.png
new file mode 100644
index 0000000..64e4d3f
Binary files /dev/null and b/docs/img/detectcovidexp.png differ
diff --git a/docs/img/detectcovidinput.png b/docs/img/detectcovidinput.png
new file mode 100644
index 0000000..9e99ccb
Binary files /dev/null and b/docs/img/detectcovidinput.png differ
diff --git a/docs/user-documentation/tutorials.md b/docs/user-documentation/tutorials.md
index 270258d..7009564 100644
--- a/docs/user-documentation/tutorials.md
+++ b/docs/user-documentation/tutorials.md
@@ -1,58 +1,74 @@
## Admin Tutorial Hands on: Create an Application with Advance Input Components
+- Section covered;
+ - <a href= "#access">Get Access</a></br>
+ - <a href= "#create">Create a New Application</a></br>
+ - <a href= "#addint">Add Application Interfaces</a></br>
+ - <a href= "#addappdep">Add Application Deployment</a></br>
+ - <a href= "#more">More Details On...</a></br>
-1. Log into <a href="https://testdrive.airavata.org/" target="_blank">TestDrive Portal</a>
+#####<h5 id="access">Getting Access</h5>
+1. Log into <a href="https://testdrive.airavata.org/" target="_blank"><b>TestDrive Portal</a></b>
<br></br>
-2. First, you'll need a user account. <a href="https://testdrive.airavata.org/auth/login" target="_blank">Create an account</a> using your existing institutional login through CILogon.
+2. First, you'll need a user account. <a href="https://testdrive.airavata.org/auth/login" target="_blank"><b>Create an account</a></b> using your existing institutional login through CILogon.
<br></br>
-3. After you've logged in, an administrator can grant you access to run the Gaussian16 application.
+3. After you've logged in, an administrator will grant you access to create the test application _**DetectCovid**_.
<br></br>
-4. During the tutorial we'll grant you access right away and let you know.
+4. When you log in for the first time you will be in the 'Workspace'. Switch to 'Settings'
<br></br>
-5. When you log in for the first time you will be in the 'Workspace'. Switch to 'Settings'
-<br></br>
-6. 'Settings' is the admin space of the gateway. Here the first is "Application Catalog"
-<br></br>
+5. 'Settings' is the admin space of the gateway. Here the first is "Application Catalog"
+<br>NOTE: the purpose of this hands on is to demonstrate some of the advance application input options available in the gateway.
-NOTE: the purpose of this hands on is to demonstrate some of the advance application input options available in the gateway.
+
+Image: Application Catalog
-#####Create New Application "Detect Covid"
+#####<h5 id="create">Create New Application "DetectCovid"</h5>
1. Application Catalog is where all the available applications are listed as well as the option to create new.
<br></br>
-2. Use "New Application" to create new application.
+2. Use _New Application+_ to create new application.
<br></br>
3. In the 'Details' tab provide the name, version and description.
+ - Application Name: DetectCovd-Peter
+ - Application Version: V1.0
+ - Application Description: Test tutorial application to detect Covid spread
<br></br>
-4. For _Application Name_ provide `DetectCovid-<your username>`. Appending your
- username will allow you to distinguish your version of _DetectCovid_ from other
+4. For _Application Name_ provide `DetectCovid-<your name>`. Appending your
+ name will allow you to distinguish your version of _**DetectCovid**_ from other
users.
+ <br> e.g. DetectCovid-Peter
<br></br>
Image: Application Details Tab
<br></br>
-4. Upon saving the 'Details' users can add 'Interface' and 'Deployment' of the application in respective tabs.
-#####Add Application Interface
+5. Upon saving the _Details_ users can add _Interface_ and _Deployment_ of the application in respective tabs.
+
+#####<h5 id="addint">Add Application Interfaces</h5>
1. Click on the **Interface** tab.
<br></br>
-2. Add the first Application Input
- - _Name_: Vaccinated?
+2. Click button, _Add application input_.
+<br></br>
+3. Add the first Application Input
+ - _Name_: Vaccination Status
- _Type_: String
- _Initial Value_: Yes
- _Application Argument_: `-v`
- _User Friendly Description_: `Add your Vaccintion Status`
- - _Required_: `True`
- _Required on Command Line_: `True`
+ - _Required_: `True`
+ - _Read Only_: `False`
-3. Add the second Application Input
+4. Add the second Application Input
- _Name_: Symptoms
- _Type_: String
- _Initial Value_: a
- _Application Argument_: `-s`
- _User Friendly Description_: `Select all your symptoms`
- - _Required_: `True`
- _Required on Command Line_: `True`
- - _metadata_:
+ - _Required_: `True`
+ - _Read Only_: `False`
+ - _Advanced Input Field Modification Metadata_:
+
<button class="btn" data-clipboard-target="#symptoms">
Copy to clipboard
@@ -87,14 +103,18 @@ Image: Application Details Tab
```
</div>
+
+Image:DetectCovid Checkbox Input
+
4. Add the third Application Input
- _Name_: Last Location
- _Type_: String
- _Initial Value_: main
- _Application Argument_: `-l`
- _User Friendly Description_: `Select your last location`
- - _Required_: `True`
- _Required on Command Line_: `True`
+ - _Required_: `True`
+ - _Read Only_: `False`
- _Metadata_
<button class="btn" data-clipboard-target="#last_location">
@@ -132,8 +152,9 @@ Image: Application Details Tab
- _Initial Value_: 50
- _Application Argument_: `-cd`
- _User Friendly Description_: `Select the crowd size of the location`
- - _Required_: `True`
- _Required on Command Line_: `True`
+ - _Required_: `True`
+ - _Read Only_: `False`
- _Metadata_
<button class="btn" data-clipboard-target="#crowd_size">
@@ -160,8 +181,14 @@ Image: Application Details Tab
```
</div>
-#####Add Application Deployment
-1. The Application Deployment is where we add command to execute the computation in a specific remote computational resource.
+6. In the interface tab, you can also add any output you explicitly wants to bring back from the remote resource and make available for the gateway users to download, for this tutorial, we will not be adding outputs.
+7. After you added all the above inputs, the experiment creation page would look like below;
+
+
+Image:Create DetectCovid Experiment
+
+#####<h5 id="addappdep">Add Application Deployment</h5>
+1. The Application **Deployment** is where we add command to execute the computation in a specific remote computational resource.
2. Choose _Expanse_ as the compute resource.
@@ -170,5 +197,8 @@ Image: Application Details Tab
4. Ignore rest of the fields and save.
5. NOTE: This application is purely to demonstrate the application input options and not to actually submit and run on a resource.
-<br>For more information refer: <a href="/user-documentation/advance-inputs" target="_blank">Advance Application Inputs</a><br>
<br></br>
+
+#####<h5 id="more">More Details On...</h5>
+1. <a href="/user-documentation/application-catalog" target="_blank">Creating Applications</a>
+2. <a href="/user-documentation/advance-inputs" target="_blank">Advance Input Options</a>
\ No newline at end of file