Skip to main content

A python package to query the National Biomedical Imaging Archive (NBIA) database.

Project description

PyTests Documentation Status codecov Python version PyPI version Downloads PyPI - Downloads GitHub repo size Docker Pulls

GitHub milestone detailsGitHub milestone details

NBIA Toolkit

nbiatoolkit is a python package that provides programmatic access to query and download images from the National Biomedical Imaging Archive (NBIA) and The Cancer Imaging Archive (TCIA) databases.

Features

  • Use NBIA Guest account to access public data OR authenticate using OAuth with user credentials for limited access data (requires approved data access).
  • Query NBIA database for metadata on collections, patients, studies, series, and images
  • Download images from NBIA
    • Validate doownloads with MD5 checksums for downloaded images
    • Auto-sort DICOM files using a user-defined pattern of DICOM tags with specialized DICOMSorter class

See Documentation at NBIA-Toolkit Read The Docs

Installation

nbiatoolkit is currently under development. It is made available via PyPI and can be installed using pip:


pip install nbiatoolkit

Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

License

nbiatoolkit was created by Jermiah Joseph. It is licensed under the terms of the MIT license.

User Agreements and Disclaimers

The NBIA-toolkit is NOT a product of the National Cancer Institute (NCI) and is not endorsed by the NCI. The NBIA-toolkit is provided as an open-source tool based on the NBIA REST API. The NBIA-toolkit is provided "AS IS" without warranty of any kind.

In no event shall the authors or contributors be liable for any claim, damages or other liability, arising from, out of or in connection with the NBIA-toolkit or the use or other dealings in the NBIA-toolkit.

Users of the NBIA-toolkit are required to abide by the NBIA REST API Terms of Service and the NBIA Data Usage Policies and Restrictions

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nbiatoolkit-0.12.1.tar.gz (14.2 kB view details)

Uploaded Source

Built Distribution

nbiatoolkit-0.12.1-py3-none-any.whl (16.8 kB view details)

Uploaded Python 3

File details

Details for the file nbiatoolkit-0.12.1.tar.gz.

File metadata

  • Download URL: nbiatoolkit-0.12.1.tar.gz
  • Upload date:
  • Size: 14.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for nbiatoolkit-0.12.1.tar.gz
Algorithm Hash digest
SHA256 4944c187bed0a101150ae3ef88a6ca88f5b30b60020ed02459f94c2c7ad49e1d
MD5 68b9b70caa65ae0be8f327c36c76728b
BLAKE2b-256 942c26cb40b56f99619468c08e7f343769c3edc1e1b1956b6336e5e4e8808a05

See more details on using hashes here.

File details

Details for the file nbiatoolkit-0.12.1-py3-none-any.whl.

File metadata

  • Download URL: nbiatoolkit-0.12.1-py3-none-any.whl
  • Upload date:
  • Size: 16.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for nbiatoolkit-0.12.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6ac226f7d6e7bfb9c76bc1264607ca432cae6c8061364561ad0666a04848b45c
MD5 35f87fc122a0f508ae57fea0acf0542c
BLAKE2b-256 160b4a6db07e1c799763e37decd84b4570f82d97f1655b5d7022e706755e297b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page