Skip to content

Commit

Permalink
add python lib install instructions to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lkeegan committed Dec 17, 2024
1 parent d3a32ae commit 93be7b8
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/data.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Introduction to the provided datasets.

## heiData

The datasets are stored on [heiData](https://heidata.uni-heidelberg.de/) which also provides a DOI.
The datasets will be stored on [heiData](https://heidata.uni-heidelberg.de/) which also provides a DOI.

Here is an example dataset: [doi:10.11588/data/TKCFEF](https://heidata.uni-heidelberg.de/dataset.xhtml?persistentId=doi:10.11588/data/TKCFEF)

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Welcome to Q-HCCC
# Welcome to Q-HCC

Some text about what this is...

Expand Down
21 changes: 20 additions & 1 deletion docs/models.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,22 @@
# Models

Introduction to the models provided at [github.com/ZhaoWenzhao/QHCC](https://github.com/ZhaoWenzhao/QHCC).
Example models and data are provided at [github.com/ZhaoWenzhao/QHCC](https://github.com/ZhaoWenzhao/QHCC).

In order to run the provided example scripts, you will need to use Python 3.8 or 3.9, and install the required Python libraries:

=== "pip"
```bash
pip install jupyter numpy pandas pooch pyradiomics simpleitk scikit-learn xgboost
```

=== "conda"
```bash
conda env create -n QHCC2 jupyter numpy pandas pooch python radiomics::pyradiomics simpleitk scikit-learn xgboost -c conda-forge -c radiomics
conda activate QHCC
```

=== "micromamba"
```bash
micromamba env create -n QHCC2 jupyter numpy pandas pooch python radiomics::pyradiomics simpleitk scikit-learn xgboost -c conda-forge -c radiomics
micromamba activate QHCC
```

0 comments on commit 93be7b8

Please sign in to comment.