petpal 0.6.0

PET-PAL (Positron Emission Tomography Processing and Analysis Library)

Positron Emission Tomography Processing and Analysis Library (PETPAL)

A comprehensive 4D-PET/MR analysis software suite.

Installation

Using Pip

The simplest way to install PETPAL is using pip. First, ensure you are using Python version >=3.12. Then, run the following:

pip install petpal

Build from source

Clone the repository using your preferred method. After navigating to the top-level directory (where pyproject.toml exists), we run the following command in the terminal:

pip install .  # Installs the package

If you are going to be actively developing and making changes to the package source code, it is recommended to instead do:

pip install -e .  # Installs the package as symlinks to the source code

Documentation

The official docs are hosted on read the docs, which contain helpful tutorials to get started with using PETPAL, and the API reference.

Building Documentation Locally

To generate the documentation in HTML using sphinx, we first navigate to the $src/docs/ directory. Then, we run the following commands:

make clean
make html 

Then, open $src/docs/build/html/index.html using any browser or your IDE.