From 71f6d27f4191459a6ba6ca8706defd3166e23b36 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Pedersen?= Date: Fri, 10 Sep 2021 19:19:35 +0200 Subject: [PATCH] Update README.md --- README.md | 35 ++++++++++++----------------------- 1 file changed, 12 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 08e6de9..1ae04f2 100644 --- a/README.md +++ b/README.md @@ -7,35 +7,21 @@ The figure shows a predicted liver mask with the corresponding patient CT in 3DSlicer. It is the Volume-10 from the LITS17 dataset. -### Credit -The LITS dataset can be accessible from [here](https://competitions.codalab.org), and the corresponding paper for the challenge from [here](https://arxiv.org/abs/1901.04056). If trained model is used, please consider citing this paper. - -### Usage: +## Install -1) Clone repo: -``` -git clone https://github.com/andreped/livermask.git -cd livermask -``` -2) Create virtual environment and intall dependencies: -``` -virtualenv -ppython3 venv -source venv/bin/activate -pip install -r /path/to/requirements.txt ``` -3) Run livermask method: -``` -cd livermask -python livermask.py "path_to_ct_nifti.nii" "output_name.nii" +pip install git+https://github.com/andreped/livermask.git ``` -If you lack any modules after, try installing them through setup.py (could be done instead of using requirements.txt): +## Usage: + ``` -pip install wheel -python setup.py bdist_wheel +livermask --input path-to-nifti.nii --output path-to-output-file.nii ``` -### DICOM/NIfTI format +In addition, there is the optional `--cpu` action to disable the GPU (force computations on CPU only) if necessary. + +## DICOM/NIfTI format Pipeline assumes input is in the NIfTI format, and output a binary volume in the same format (.nii). DICOM can be converted to NIfTI using the CLI [dcm2niix](https://github.com/rordenlab/dcm2niix), as such: ``` @@ -44,9 +30,12 @@ dcm2niix -s y -m y -d 1 "path_to_CT_folder" "output_name" Note that "-d 1" assumed that "path_to_CT_folder" is the folder just before the set of DICOM scans you want to import and convert. This can be removed if you want to convert multiple ones at the same time. It is possible to set "." for "output_name", which in theory should output a file with the same name as the DICOM folder, but that doesn't seem to happen... -### Troubleshooting +## Troubleshooting You might have issues downloading the model when using VPN. If any issues are observed, try to disable VPN and try again. +## Acknowledgements +The LITS dataset can be accessible from [here](https://competitions.codalab.org), and the corresponding paper for the challenge from [here](https://arxiv.org/abs/1901.04056). If trained model is used, please consider citing this paper. + ------ Made with :heart: and python