Skip to main content

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

Project description

GitHub milestone detailsGitHub milestone details

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

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.11.2.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

nbiatoolkit-0.11.2-py3-none-any.whl (16.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for nbiatoolkit-0.11.2.tar.gz
Algorithm Hash digest
SHA256 78ac63e71ce6a2b6ae883ca8a7048ea4615a188bf8d032bda1b45e7b55570f3d
MD5 4f278c8fda3bdaf62e629528148012ca
BLAKE2b-256 6cff2821ceda65f543e49089e28c0fe8337d6e8033451ddf4728b03a07827749

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nbiatoolkit-0.11.2-py3-none-any.whl
  • Upload date:
  • Size: 16.7 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.11.2-py3-none-any.whl
Algorithm Hash digest
SHA256 aec4484033e900a10ca0b8faed7338aa05241d6d1908b7be1821e7778cb49a9e
MD5 26f2a1c05cca98cd132b4d430219e512
BLAKE2b-256 58ef279184e7aa338325315b818cf9ab98a16cb0611b89701c8c7d515acbd8a1

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