-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #23 from jcfr/jcfr-updat-readme-install-from-exten…
…sions-manager DOC: Update README to account for automatic install of python packages
- Loading branch information
Showing
1 changed file
with
19 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,18 +19,30 @@ The extension provides a single module - **MONAIViz** - which currently supports | |
|
||
## Installing Plugin | ||
|
||
### Prerequisites | ||
You need to install MONAI and dependencies before using this plugin. | ||
### Installing 3D Slicer | ||
|
||
- Install the [PyTorch extension](https://github.com/fepegar/SlicerPyTorch) | ||
- Open Python Console (View Menu) in 3D Slicer | ||
- Run the following command: | ||
- `pip_install("monai[itk,nibabel]")` | ||
- Restart 3D Slicer | ||
To use MONAIViz with 3D Slicer, you'll need to download and install 3D Slicer. MONAIViz supports the stable and preview versions of 3D Slicer, version 5.3 or higher. For more information on installing 3D Slicer, check out the [3D Slicer Documentation](https://slicer.readthedocs.io/en/latest/user_guide/getting_started.html#installing-3d-slicer) | ||
|
||
### Installing MONAIViz Plugin | ||
|
||
- Go to **View** -> **Extension Manager** -> **Developer Tools** -> **MONAIViz** | ||
- Install MONAIViz plugin | ||
- _**Restart**_ 3D Slicer | ||
|
||
**Note:** To update the plugin to the latest version, you have to uninstall the existing 3D Slicer version and download and install the new preview version of 3D Slicer again | ||
|
||
### Install Plugin in Developer Mode | ||
|
||
- `git clone [email protected]:Project-MONAI/SlicerMONAIViz.git` | ||
- Open 3D Slicer: Go to **Edit** -> **Application Settings** -> **Modules** -> **Additional Module Paths** | ||
- Add New Module Path: _<FULL_PATH>_/SlicerMONAIViz/MONAIViz | ||
- _**Restart**_ 3D Slicer | ||
|
||
## Dependencies | ||
|
||
MONAIViz depends on the following packages: | ||
|
||
* [PyTorch Slicer extension](https://github.com/fepegar/SlicerPyTorch) | ||
* `monai[itk,nibabel]` python packages | ||
|
||
**Note:** After opening the MONAIViz module in 3D Slicer for the first time, you will be asked to confirm the installation of the packages. |