Installation

This guide will walk you through the installation process for DICaugment, a Python package for 3D image augmentation specifically designed for volumetric 3D images like CT scans.

Prerequisites

Before installing DICaugment, ensure you have the following prerequisites:

  • Python 3.8 or higher

Installation Steps

Follow these steps to install dicaugment:

  1. Open a terminal or command prompt.

  2. Create a new virtual environment (optional but recommended):

    python -m venv myenv

  3. Activate the virtual environment:

    • On Windows:

      myenv\Scripts\activate

    • On macOS and Linux:

      source myenv/bin/activate

  4. Install DICaugment and its dependencies using pip:

    pip install dicaugment

This will install DICaugment along with the required dependencies.

  1. Verify the installation by importing DICaugment in Python:

    import dicaugment as dca

If no errors occur, the installation was successful.

Upgrade to the Latest Version

To upgrade to the latest version of DICaugment, use the –upgrade flag with pip:

pip install --upgrade dicaugment

This will update DICaugment to the latest available version.

Uninstall DICaugment

To uninstall DICaugment, use the following pip command:

pip uninstall dicaugment

Confirm the uninstallation when prompted.

Additional Notes

  • It’s recommended to install DICaugment in a virtual environment to isolate it from other Python packages and prevent conflicts.

  • If you encounter any issues during installation, please seek help from the dicaugment community on the DICaugment GitHub Discussions page.

Congratulations! You have successfully installed DICaugment. You can now proceed to the Getting Started guide to learn how to use DICaugment for 3D image augmentation.