Skip to content
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
3 changes: 3 additions & 0 deletions user-guide/docs/include/api-note.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
TAPIS is well documented at [TAPIS](https://tapis-project.org/documentation/){ target="_blank" }. Interaction with TAPIS is available with Python via [`tapipy`](https://github.com/tapis-project/tapipy){ target="_blank" }. And there is an [introduction to TAPIS for OpenSees on DesignSafe](https://designsafe-ci.github.io/training-OpenSees-on-DesignSafe/Docs_MD/tapis_intro.html){ target="_blank" }. DesignSafe provides programmatic access to all platform resources through the TAPIS API. All API interactions use `https://designsafe.tapis.io` as the base URL.

_**Note:** Jupyter sessions on DesignSafe no longer automatically authenticate with TAPIS. You must manually authenticate using the base URL. [Learn more.](/user-guide/tools/jupyterhub/#using-tapis)_
13 changes: 13 additions & 0 deletions user-guide/docs/managingdata/datatransfer.md
Original file line number Diff line number Diff line change
Expand Up @@ -577,3 +577,16 @@ Return to the Google Drive section of the Data Depot. You can now copy files to

![Complete Google Drive](./imgs/cloudstorage-1.png)
-->

## Programmatic Data Transfer via API { #api }

For automated or large-scale data transfers, DesignSafe provides programmatic access through the TAPIS API. This method is particularly useful for:

- Automated data synchronization workflows
- Integration with external analysis pipelines
- Bulk file operations and metadata management
- Custom data processing applications

### Getting Started with API Access { #api-setup }

{% include-markdown '../include/api-note.md' %}
11 changes: 11 additions & 0 deletions user-guide/docs/tools/advanced/dsfaq.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ An Expanding Collection of the Most Frequently Asked Questions
- [OpenFOAM](#faq-openfoam)
- [ParaView](#faq-paraview)
- [Experimental Facilities](#faq-ef)
- [Programmatic Access](#faq-api)
- [Data Curation & Publication](/user-guide/curating/faq/)

---
Expand Down Expand Up @@ -253,6 +254,16 @@ If you do not specify a location, the default output is shown in the grayed-out

---

## Programmatic Access { #faq-api }

/// details | How can I learn to use TAPIS?

{% include-markdown '../../include/api-note.md' %}

///

---

## Experimental Facilities { #faq-ef }

/// details | What Experimental Facilities are available to the natural hazards engineering community?
Expand Down
8 changes: 7 additions & 1 deletion user-guide/docs/tools/jupyterhub/jupyterhub.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,13 @@ Each Jupyter session is served through an Ubuntu-based Docker image and distribu

#### High Performance Computing (HPC) Job Submission through Jupyter { #using-jobs }

For greater computational power, you can use <em>agavepy</em>, a Python interface to TAPIS, to submit jobs to TACC's high performacne computing systems (e.g., Frontera) directly through Jupyter. Existing applications avaialble through DesignSafe include OpenSees, SWbatch, ADCIRC and others. For more information, please watch [this webinar on leveraging DesignSafe using TAPIS](https://youtu.be/-_1lNWW8CAg){target="_blank"}.
For greater computational power, you can use [_tapipy_](https://github.com/tapis-project/tapipy), a Python interface to [TAPIS](https://tapis-project.org/), to submit jobs to TACC's high performance computing systems (e.g., Frontera) directly through Jupyter. Existing applications available through DesignSafe include OpenSees, SWbatch, ADCIRC and others. For more information, please watch [this webinar on leveraging DesignSafe using TAPIS](https://youtu.be/-_1lNWW8CAg){target="_blank"}.

##### Programmatic Access to DesignSafe Resources { #using-tapis }

For programmatic access to DesignSafe resources from within Jupyter (such as managing files, submitting jobs, or accessing metadata), you'll need to authenticate with TAPIS.

{% include-markdown '../../include/api-note.md' %}

### Installing Packages { #installing }

Expand Down
2 changes: 1 addition & 1 deletion user-guide/docs/usecases/arduino/usecase.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The following DesignSafe resources were used in developing this use case.
* [DesignSafe - Jupyter notebooks on DS Juypterhub](https://www.designsafe-ci.org/use-designsafe/tools-applications/analysis/jupyter/)
* [SimCenter - quoFEM](https://www.designsafe-ci.org/use-designsafe/tools-applications/simulation/quofem/)
* [Simulation on DesignSafe - OpenSees](https://www.designsafe-ci.org/use-designsafe/tools-applications/simulation/opensees/)

* [Programmatic Access - TAPIS](/user-guide/tools/advanced/dsfaq/#faq-api)

### Background

Expand Down
3 changes: 1 addition & 2 deletions user-guide/docs/usecases/arduino/usecase_matlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,7 @@ It is emphasized that the main motivation of this notebook is to take advantage

### Setup tapis/agave app and run Matlab script

The notebook can be executed launching *Jupyter Lab* in Designsafe. This opens a user *docker container* in DesignSafe that includes all the functionality required to execute jupyter commands. This gives immediate access to the **agavepy** module from which it is possible to run any **TAPIS** APP.

The notebook can be executed launching *Jupyter Lab* in Designsafe. This opens a user *docker container* in DesignSafe that includes all the functionality required to execute Jupyter commands. This gives immediate access to the **`tapispy`**/**`agavepy`** module from which it is possible to run any **TAPIS** APP. See [Programmatic Access via TAPIS](/user-guide/tools/advanced/dsfaq/#faq-api).

#### Setup job description

Expand Down