Metadata-Version: 2.4
Name: tcia_utils
Version: 3.0.2
Summary: A package to simplify common tasks one might perform when interacting with The Cancer Imaging Archive (TCIA) via Jupyter/Python.
Project-URL: Homepage, https://github.com/kirbyju/tcia_utils
Project-URL: Bug Tracker, https://github.com/kirbyju/tcia_utils/issues
Author-email: Justin Kirby <justin.kirby@nih.gov>
License-File: LICENSE
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Requires-Dist: bs4
Requires-Dist: pandas
Requires-Dist: plotly
Requires-Dist: requests
Requires-Dist: unidecode
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-mock; extra == 'test'
Description-Content-Type: text/markdown

# Overview
The [tcia_utils](https://pypi.org/project/tcia-utils/) package contains functions to simplify common tasks one might perform when interacting with The Cancer Imaging Archive (TCIA) via Jupyter/Python. Learn more about TCIA and its open-access datasets at https://www.cancerimagingarchive.net/.  Please be sure to comply with the [TCIA Data Usage Policy](https://wiki.cancerimagingarchive.net/x/c4hF).

[![Downloads](https://static.pepy.tech/personalized-badge/tcia-utils?period=month&units=international_system&left_color=blue&right_color=grey&left_text=Downloads%20/%20Month)](https://pepy.tech/project/tcia-utils)

# Installation
```
pip install tcia_utils
```

# Usage

To import functions related to Wordpress, which holds metadata for TCIA datasets:
```
from tcia_utils import wordpress
```

To import functions related to the NBIA software, which holds TCIA's DICOM radiology data:
```
from tcia_utils import nbia
```

To import functions related to the PathDB software, which holds TCIA's histopathology data:
```
from tcia_utils import pathdb
```

To import functions related to Datacite, which holds information about citations and Digital Object Identifiers (DOIs) for TCIA datasets:
```
from tcia_utils import datacite
```

Example notebooks demonstrating tcia_utils functionality can be found at https://github.com/kirbyju/TCIA_Notebooks.
