Skip to content

Commit

Permalink
docs: update README with installation + badges
Browse files Browse the repository at this point in the history
  • Loading branch information
jjjermiah committed Oct 22, 2024
1 parent 9472ab6 commit 7bdf5d3
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
# READII
[![Docker Pulls](https://img.shields.io/docker/pulls/bhklab/readii)](https://hub.docker.com/r/bhklab/readii)
[![codecov](https://codecov.io/gh/bhklab/readii/graph/badge.svg?token=obsN5dhXPx)](https://codecov.io/gh/bhklab/readii)
[![CI-CD](https://github.com/bhklab/readii/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/bhklab/readii/actions/workflows/ci-cd.yml)
[![CodeFactor](https://www.codefactor.io/repository/github/bhklab/readii/badge)](https://www.codefactor.io/repository/github/bhklab/readii)

![GitHub Release](https://img.shields.io/github/v/release/bhklab/readii)
[![pixi-badge](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json&style=flat-square)](https://github.com/prefix-dev/pixi)

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/readii)](https://pypi.org/project/readii/)
[![PyPI - Version](https://img.shields.io/pypi/v/readii)](https://pypi.org/project/readii/)
[![PyPI - Format](https://img.shields.io/pypi/format/readii)](https://pypi.org/project/readii/)
[![Downloads](https://static.pepy.tech/badge/readii)](https://pepy.tech/project/readii)
[![Docker Pulls](https://img.shields.io/docker/pulls/bhklab/readii)](https://hub.docker.com/r/bhklab/readii)

**R**adiomic **E**xtraction and **A**nalysis for **DI**COM **I**mages

Expand All @@ -15,6 +22,14 @@ A package to extract radiomic features from DICOM CT images.
$ pip install readii
```

### (recommended) Create new `pixi` environment for a project
```bash
mkdir my_project
cd my_project
pixi init
pixi add --pypi readii
```

### (recommended) Create new conda virtual environment
```
conda create -n readii python=3.9
Expand Down

0 comments on commit 7bdf5d3

Please sign in to comment.