Metadata-Version: 2.4
Name: petpal
Version: 0.6.3
Summary: PET-PAL (Positron Emission Tomography Processing and Analysis Library)
Project-URL: Repository, https://github.com/PETPAL-WUSM/PETPAL.git
Author-email: Noah Goldman <noahg@wustl.edu>, Bradley Judge <bjudge@wustl.edu>, Furqan Dar <dar@wustl.edu>, Kenan Oestreich <kenan.oestreich@wustl.edu>
License-File: LICENSE
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Image Processing
Requires-Python: >=3.12
Requires-Dist: antspyx>=0.5
Requires-Dist: bids-validator
Requires-Dist: docker
Requires-Dist: fslpy
Requires-Dist: lmfit
Requires-Dist: matplotlib
Requires-Dist: networkx
Requires-Dist: nibabel
Requires-Dist: numba
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: pydata-sphinx-theme
Requires-Dist: scikit-learn
Requires-Dist: scipy
Requires-Dist: seaborn
Requires-Dist: simpleitk
Requires-Dist: sphinx
Requires-Dist: sphinx-autoapi
Requires-Dist: sphinx-design
Description-Content-Type: text/markdown

# Positron Emission Tomography Processing and Analysis Library (PETPAL)

<figure>
<img src="docs/PETPAL_Logo.png" alt="PETPAL Logo" width="50%">
<figcaption>A comprehensive 4D-PET/MR analysis software suite.</figcaption>
</figure>



## 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:

```shell
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:

```shell
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:

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

## Documentation
 The official docs are hosted on [read the docs](https://petpal.readthedocs.io/en/latest/), 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:

```shell
make clean
make html 
```

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