Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

DAPI - DesignSafe API

build and test License PyPI version

dapi is a Python library for submitting, monitoring, and managing TAPIS v3 jobs on DesignSafe via Jupyter Notebooks or the command line. It also provides access to DesignSafe research databases.

dapi
from dapi import DSClient

ds = DSClient()

input_uri = ds.files.to_uri("/MyData/analysis/input/")

job_request = ds.jobs.generate(
 app_id="matlab-r2023a",
 input_dir_uri=input_uri,
 script_filename="run_analysis.m",
 allocation="your_allocation",
)
job = ds.jobs.submit(job_request)
job.monitor()

For background on DesignSafe compute environments, storage, and workflow design, see the DesignSafe Workflows guide.

Getting Started

User Guide

Examples

Support

Report bugs or request features on GitHub Issues.

License

MIT License (view)