Getting Started#

Installation#

PlatiPy is available from the Python package repositories and can be installed with:

pip install platipy

The base installation of platipy does not include some large libraries needed for various components of platipy. The following extras are available to install to run specific platipy tools:

pip install platipy[cardiac] pip install platipy[nnunet] pip install platipy[backend]

If you have already installed the library, you can install the latest updates using:

pip install --upgrade platipy

Getting Started#

Command Line Interface (CLI)#

Once you have installed PlatiPy, the platipy command should be available in your environment. Try the following command to check that is is working:

platipy --help

This lists the different tools which are available via the command line interface. Learn more about these tools and how to use them here: here.

Python#

Jupyter Notebooks#

The following Jupyter Notebooks are provided to demonstrate how to use some of the PlatiPy functionality from your Python code:

Demonstration of PlatiPy’s Visualisation tools#
Open In Colab
Contour Comparison Example#
Open In Colab
Example DVH analysis#
Open In Colab
DICOM data cleaning and preparation Example#
Open In Colab
DICOM RTSTRUCT Conversion Example#
Open In Colab
Download from TCIA Example#
Open In Colab
Atlas-based segmentation example#
Open In Colab
Example to Perform Hybrid (Deep Learning+Atlas) Heart Segmentation#
Open In Colab
Example to Perform Cardiac Left Ventricle 17-segment model Segmentation#
Open In Colab
Example to Perform Automatic Bronchial Tree Segmentation#
Open In Colab
Examples to Generate Synthetic Deformations for Head & Neck#
Open In Colab