Skip to content

Commit

Permalink
fix: add image
Browse files Browse the repository at this point in the history
  • Loading branch information
mosoriob committed May 24, 2024
1 parent bde9b31 commit 997ab0a
Show file tree
Hide file tree
Showing 7 changed files with 78 additions and 17 deletions.
Binary file removed .DS_Store
Binary file not shown.
33 changes: 33 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Created by https://www.toptal.com/developers/gitignore/api/osx
# Edit at https://www.toptal.com/developers/gitignore?templates=osx

### OSX ###
# General
.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon

# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk

# End of https://www.toptal.com/developers/gitignore/api/osx

Expand Down
62 changes: 45 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,65 @@
This is the template for a cookbooks' tutorial. The goal is to provide an environment that can be reproducible and stood up on TACC Systems.
This tutorial is the first in a [series of tutorials](next-tutorials) that will guide you through the process of creating a cookbook and running it on TACC systems. From simple ones that run a command to more complex ones that run a Python using conda or a Jupyter Notebook.

## Requirements

- A GitHub account
- TACC account. If you don't have one, you can request one [here](https://accounts.tacc.utexas.edu/register)
- To access TACC systems, you should have an [allocation](https://tacc.utexas.edu/use-tacc/allocations/)
- You can see your allocations [here](https://ptdatax.tacc.utexas.edu/workbench/allocations/approved)
- If you don't have an allocation, you can request one [here](https://portal.tacc.utexas.edu/allocation-request)

## Tutorial

In this tutorial, we will create a cookbook that will be used to demonstrate how run a command on TACC cluster and obtain the output.
In this tutorial, we will create a simple cookbook that will be used to demonstrate how to run a cookbook a TACC cluster and obtain the output using a UI.

This cookbook will run the job using two parameters/arguments `Greeting` and `Target` and save the output to a file named `out.txt`.

![alt text](images/parameters.png)

![Show the output content ](images/output-content.png)

### Create a new Github Repository
### How does it work?

1. Go to [Cookbook-Tutorial-Template](https://github.com/In-For-Disaster-Analytics/Cookbook-Tutorial-Template)
2. Click on the "Use this template" button
3. Name your repository and click "Create repository"
1. The [`app.json`](app.json) file contains the definition of the Tapis application, including the application's name, description, Docker image, parameters and advanced options.
2. The Docker image defines the runtime environment for the application. Also, it includes `run.sh` file that contains the commands that will be executed by the Tapis job. A Docker Image is built from the [`Dockerfile` file](./Dockerfile).
3. The file [`run.sh`](run.sh) contains all the commands that will be executed by the Tapis job.

### Update the Cookbook definition `app.json` file
### 1. Update the Cookbook Definition `app.json` File

A Tapis application represents all the information required to run a Tapis job on a Tapis system. The `app.json` file is the definition of the Tapis application such as application's name, description, and the environment that the application will run in.
Each app has a unique `id` and `description`. So, you should change these fields to match your app's name and description.

1. Open the `app.json` file in the root of your repository
2. Update the `id` and `description` fields with the name and description of your cookbook
1. Download the `app.json` file
2. Change the values `id` and `description` fields with the name and description as you wish.

### Create a new application on the Cookbook UI
### Create a New Application on the Cookbook UI

1. Go to [Cookbook UI](https://in-for-disaster-analytics.github.io/cookbooks-ui/#/apps)
2. Click on the "Create Application" button
3. Fill in the form with the information from your `app.json` file
4. Click "Create Application"
5. A new application will be created, and you will be redirected to the application's page

### Run Your Cookbook

1. Click on the "Run" button on the right side of the page. This will open the Portal UI
2. Fill in the form with the necessary parameters
3. Click "Run"

### Check the Output

1. After the job finishes, you can check the output by clicking on the "Output location" link on the job's page
![Show a job finished ](images/job-finished.png)
2. You will be redirected to the output location, where you can see the output files generated by the job
![Show the output files ](images/output-files.png)
3. Click on a file to see its content. In this case, the file is named `out.txt`
![Show the output content ](images/output-content.png)

### Test your Cookbook
## Next Tutorials

1. Go to the [Cookbook UI](https://in-for-disaster-analytics.github.io/cookbooks-ui/#/apps)
2. Click on your cookbook
3. Click on the "Run" button on the right side of the page. This will open the Portal UI
4. Fill in the form with the necessary parameters
5. Click "Run"
- [Running a Python script]
- [Running a Jupyter Notebook]

## Authors

William Mobley - [email protected]
Maximiliano Osorio
Binary file added images/job-finished.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/output-content.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/output-files.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/parameters.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 997ab0a

Please sign in to comment.