Skip to content

Commit 93e7ffd

Browse files
committed
docs: add PyPI/CI badges and updated install instructions
1 parent 6bc2a53 commit 93e7ffd

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# synthdiet
22

3+
[![PyPI version](https://img.shields.io/pypi/v/synthdiet.svg)](https://pypi.org/project/synthdiet/)
4+
[![Python versions](https://img.shields.io/pypi/pyversions/synthdiet.svg)](https://pypi.org/project/synthdiet/)
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6+
[![CI](https://github.com/bugraayancom/synthdiet/actions/workflows/ci.yml/badge.svg)](https://github.com/bugraayancom/synthdiet/actions/workflows/ci.yml)
7+
38
A Python library for generating synthetic patients with realistic clinical
49
conditions and simulating dietary interventions on them.
510

@@ -74,7 +79,16 @@ patients before bringing them to a clinic.
7479
## Installation
7580

7681
```bash
77-
pip install -e ".[dev,viz]"
82+
pip install synthdiet
83+
```
84+
85+
Optional extras:
86+
87+
```bash
88+
pip install "synthdiet[viz]" # matplotlib visualisations
89+
pip install "synthdiet[causal]" # networkx DAG export
90+
pip install "synthdiet[docs]" # Sphinx + furo + myst-parser
91+
pip install "synthdiet[dev]" # pytest + ruff + mypy + matplotlib
7892
```
7993

8094
`synthdiet` requires Python 3.9+ and depends on `numpy`, `pandas`, and `scipy`.

0 commit comments

Comments
 (0)