Skip to content

Commit

Permalink
docs: add Zenodo badge
Browse files Browse the repository at this point in the history
  • Loading branch information
kelly-sovacool committed Aug 26, 2024
1 parent def0376 commit 4e4f7f3
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,40 @@
# CCBR Tools

<!-- README.md is generated from README.qmd. Please edit that file -->

# CCBR Tools

Utilities for CCBR Bioinformatics Software

[![build](https://github.com/CCBR/Tools/actions/workflows/build-python.yml/badge.svg)](https://github.com/CCBR/Tools/actions/workflows/build-python.yml)
[![docs](https://github.com/CCBR/Tools/actions/workflows/docs-quartodoc.yml/badge.svg)](https://github.com/CCBR/Tools/actions/workflows/docs-quartodoc.yml)
[![codecov](https://codecov.io/gh/CCBR/Tools/graph/badge.svg?token=O73NOR65B3)](https://codecov.io/gh/CCBR/Tools)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13377166.svg)](https://doi.org/10.5281/zenodo.13377166)

## Installation

On biowulf you can access the latest release of `ccbr_tools` by loading
the ccbrpipeliner module:

``` sh
```sh
module load ccbrpipeliner
```

Outside of biowulf, you can install the package with pip:

``` sh
```sh
pip install git+https://github.com/CCBR/Tools
```

Or specify a specific tagged version or branch:

``` sh
```sh
pip install git+https://github.com/CCBR/Tools@main
```

## Usage

### CLI

``` sh
```sh
ccbr_tools --help
```

Expand Down Expand Up @@ -62,7 +63,7 @@ ccbr_tools --help

### Python

``` python
```python
import ccbr_tools.pkg_util
print(ccbr_tools.pkg_util.get_version())
```
Expand Down
1 change: 1 addition & 0 deletions README.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Utilities for CCBR Bioinformatics Software
[![build](https://github.com/CCBR/Tools/actions/workflows/build-python.yml/badge.svg)](https://github.com/CCBR/Tools/actions/workflows/build-python.yml)
[![docs](https://github.com/CCBR/Tools/actions/workflows/docs-quartodoc.yml/badge.svg)](https://github.com/CCBR/Tools/actions/workflows/docs-quartodoc.yml)
[![codecov](https://codecov.io/gh/CCBR/Tools/graph/badge.svg?token=O73NOR65B3)](https://codecov.io/gh/CCBR/Tools)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13377166.svg)](https://doi.org/10.5281/zenodo.13377166)

## Installation

Expand Down

0 comments on commit 4e4f7f3

Please sign in to comment.