Skip to content

Commit

Permalink
Update badges and links on README
Browse files Browse the repository at this point in the history
  • Loading branch information
kks32 committed Nov 2, 2023
1 parent 92f4858 commit 6df825c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Lint and test
name: Build, Lint, and Test

on: [push, pull_request]
jobs:
Expand Down
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# DesignSafe Jobs

[![Lint and test](https://github.com/DesignSafe-CI/dsjobs/actions/workflows/lint-test.yml/badge.svg)](https://github.com/DesignSafe-CI/dsjobs/actions/workflows/lint-test.yml)
[![build and test](https://github.com/DesignSafe-CI/dsjobs/actions/workflows/build-test.yml/badge.svg)](https://github.com/DesignSafe-CI/dsjobs/actions/workflows/build-test.yml)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md)
[![Docs](https://img.shields.io/badge/view-docs-8A2BE2?color=8A2BE2)](https://designsafe-ci.github.io/dsjobs/dsjobs/index.html)

`dsjobs` is a library that simplifies the process of submitting, running, and monitoring [TAPIS v2 / AgavePy](https://agavepy.readthedocs.io/en/latest/index.html) jobs on [DesignSafe](https://designsafe-ci.org) via [Jupyter Notebooks](https://jupyter.designsafe-ci.org).

Expand Down Expand Up @@ -29,6 +30,8 @@ pip install git+https://github.com/DesignSafe-CI/dsjobs.git --quiet

* [Jupyter Notebook Templates](example-notebooks/template-mpm-run.ipynb) using DSJobs.

* View [DSJobs API doc](https://designsafe-ci.github.io/dsjobs/dsjobs/index.html)

On [DesignSafe Jupyter](https://jupyter.designsafe-ci.org/):

Install the latest version of `dsjobs` and restart the kernel (Kernel >> Restart Kernel):
Expand All @@ -52,6 +55,8 @@ dir(ds)

## Documentation

View [DSJobs API doc](https://designsafe-ci.github.io/dsjobs/dsjobs/index.html)

To generate API docs:

```
Expand Down

0 comments on commit 6df825c

Please sign in to comment.