DSJobs simplifies accessing TAPIS on DesignSafe
Project description
DesignSafe Jobs
dsjobs
is a library that simplifies the process of submitting, running, and monitoring TAPIS v2 / AgavePy jobs on DesignSafe via Jupyter Notebooks.
Features
-
Simplified TAPIS v2 Calls: No need to fiddle with complex API requests.
dsjobs
abstracts away the complexities. -
Seamless Integration with DesignSafe Jupyter Notebooks: Launch DesignSafe applications directly from the Jupyter environment.
Installation
Install dsjobs
via pip
pip3 install dsjobs
To install the current development version of the library use:
pip install git+https://github.com/DesignSafe-CI/dsjobs.git --quiet
Example usage:
-
Jupyter Notebook Templates using DSJobs.
-
View DSJobs API doc
Install the latest version of dsjobs
and restart the kernel (Kernel >> Restart Kernel):
# Remove any previous installations
!pip uninstall dsjobs -y
# Install
!pip install dsjobs --quiet
- Import
dsjobs
library
import dsjobs as ds
- To list all functions in
dsjobs
dir(ds)
Documentation
View DSJobs API doc
To generate API docs:
pdoc --html --output-dir docs dsjobs --force
Support
For any questions, issues, or feedback submit an issue
Development
To develop or test the library locally. Install Poetry. In the current repository run the following commands
poetry shell
poetry install
poetry build
To run the unit test
poetry run pytest -v
License
dsjobs
is licensed under the MIT License.
Authors
- Prof. Pedro Arduino, University of Washington
- Krishna Kumar, University of Texas at Austin
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.