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

# Initialize client (handles authentication automatically)
ds = DSClient()

# Submit a job
job_request = ds.jobs.generate(
 app_id="matlab-r2023a",
 input_dir_uri="/MyData/analysis/input/",
 script_filename="run_analysis.m"
)
job = ds.jobs.submit(job_request)

# Monitor progress
final_status = job.monitor()

# Query research databases
df = ds.db.ngl.read_sql("SELECT * FROM SITE LIMIT 10")

Getting Started

User Guide

Examples

Support

Report bugs or request features on GitHub Issues.

License

MIT License (view)