Skip to content

Commit

Permalink
update model python lib install instructions, add requriements/env fi…
Browse files Browse the repository at this point in the history
…les to web page for download
  • Loading branch information
lkeegan committed Dec 17, 2024
1 parent 93be7b8 commit abb5726
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 3 deletions.
1 change: 1 addition & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,5 @@ jobs:
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material
- run: cp requirements.txt environment.yml docs/.
- run: mkdocs gh-deploy --force
28 changes: 25 additions & 3 deletions docs/models.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,29 @@

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:
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.
You can do this with pip, by first [downloading requirements.txt](requirements.txt) and then running:

=== "pip"
```bash
pip install -r requirements.txt
```

Or with conda or micromamba, by first [downloading environment.yml](environment.yml) and then running:

=== "conda"
```bash
conda env create -f environment.yml
conda activate QHCC
```

=== "micromamba"
```bash
micromamba env create -f environment.yml
micromamba activate QHCC
```

Alternatively you can install the required Python libraries directly:

=== "pip"
```bash
Expand All @@ -11,12 +33,12 @@ In order to run the provided example scripts, you will need to use Python 3.8 or

=== "conda"
```bash
conda env create -n QHCC2 jupyter numpy pandas pooch python radiomics::pyradiomics simpleitk scikit-learn xgboost -c conda-forge -c radiomics
conda env create -n QHCC 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 env create -n QHCC jupyter numpy pandas pooch python radiomics::pyradiomics simpleitk scikit-learn xgboost -c conda-forge -c radiomics
micromamba activate QHCC
```

0 comments on commit abb5726

Please sign in to comment.