Metadata-Version: 2.1
Name: giraffenn
Version: 1.0.1
Summary: GNN TCR Python Package
Keywords: gnn,tcr,bioinformatics,machine-learning
Author-Email: Amos Choo <amos.choo@uq.edu.au>
License: MIT
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Project-URL: Homepage, https://github.com/tuonglab/gnn_release
Project-URL: Documentation, https://gnn-release.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/tuonglab/gnn_release
Project-URL: Issues, https://github.com/tuonglab/gnn_release/issues
Requires-Python: >=3.11
Requires-Dist: torch_geometric<2.8,>=2.7
Requires-Dist: numpy<3.0,>=2
Requires-Dist: scipy<2.0,>=1.16
Requires-Dist: pandas<3.1,>=2.2
Requires-Dist: matplotlib>=3.10
Requires-Dist: seaborn>=0.13
Requires-Dist: networkx>=3.6
Requires-Dist: biopython>=1.86
Provides-Extra: docs
Requires-Dist: sphinx>=8; extra == "docs"
Requires-Dist: furo; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Requires-Dist: sphinx-autobuild; extra == "docs"
Requires-Dist: sphinx_rtd_theme; extra == "docs"
Requires-Dist: myst-nb; extra == "docs"
Description-Content-Type: text/markdown

# Utilising Machine Learning to classify cancer using Paedatric Immune Repertoire
![Logo](https://raw.githubusercontent.com/tuonglab/gnn_release/main/giraffenn.png)
## Installation

First install PyTorch for your platform. https://pytorch.org/get-started/locally/. This software is GPU-enabled

Pytorch Version to Install:

    "torch>=2.7,<2.8",
    "torchvision>=0.22,<0.23",
    "torchaudio>=2.7,<2.8",

Then install giraffenn:

```bash
pip install giraffenn
```


### For developers
```bash

`pip install pdm`
`pdm install -E`
`pytest`
