Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: move Utilities out of Hazards #53

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions user-guide/docs/tools/hazard.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,3 @@
{% include-markdown 'hazard/hazardapps.md' %}

{% include-markdown 'hazard/jupyter-dedm.md' %}

{% include-markdown 'hazard/utilities.md' %}


37 changes: 0 additions & 37 deletions user-guide/docs/tools/hazard/utilities.md

This file was deleted.

32 changes: 32 additions & 0 deletions user-guide/docs/tools/utilities.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Utilities

Most web browsers do not support upload/download of Folders, only Files. For moving Folders in and out of the Data Depot, we provide Compress and Extract tools that enable you to transform your Folder into a File (Compress) or to convert that File back into a Folder (Extract).

## Compress Folder

Tranforms your Folder into a File.

### How to submit a Compress Job in the Workspace

1. Select the Compress application from the Utilites tab in the Workspace.
2. Locate your Directory (Folder) with your files that are in the Data Depot and follow the onscreen directions to enter this directory to be compressed in the form.
3. Select a compression type from the dropdown menu.
4. Enter a maximum job runtime in the form. See guidance on form for selecting a runtime.
5. Enter a job name.
6. Enter an output archive location or use the default provided.
7. Click Run to submit your job.
8. Check the job status by clicking on the arrow in the upper right of the job submission form.

## Extract tar/zip/gzip File

Extracts the contents of a Compressed file back into its original set of Folder(s) and the Files they contained.

### How to submit an Extract Job in the Workspace

1. Select the Extract application from the Utilites tab in the Workspace.
2. Locate your file in the Data Depot and follow the onscreen directions to enter this file to be extracted in the form.
3. Enter a maximum job runtime in the form. See guidance on form for selecting a runtime.
4. Enter a job name.
5. Enter an output archive location or use the default provided.
6. Click Run to submit your job.
7. Check the job status by clicking on the arrow in the upper right of the job submission form.
3 changes: 2 additions & 1 deletion user-guide/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ nav:

- Tools and Apps:
- Analysis Applications: analysis.md
- Hazard Apps & Utilities: tools/hazard.md
- Hazard Apps: tools/hazard.md
- Utilities: tools/utilities.md
- Jupyter: tools/jupyterhub.md
- Visualization Applications: tools/visualization.md

Expand Down