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 PyPI - Downloads GitHub repo size

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
    • Calculate MD5 checksums for downloaded images
    • Auto-sort DICOM files using a user-defined pattern of DICOM tags

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

Uploaded Source

Built Distribution

nbiatoolkit-0.10.1-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for nbiatoolkit-0.10.1.tar.gz
Algorithm Hash digest
SHA256 68862bab7f4e5ecb8516a47c90f8204160dba9bd547ab3f8066c13bd360b2b13
MD5 e687a9a66689972277e06a680b9b2ee3
BLAKE2b-256 75017eaef7728f59cf9c8421c81341cabb1c8b579807f298fef0d59a5ba17540

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nbiatoolkit-0.10.1-py3-none-any.whl
  • Upload date:
  • Size: 16.6 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.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0b3b258e52fd1220a1f3b5369012ba1b189e6c5ffeded5e80f09aad0a783ff2b
MD5 4163a7a2b3f7be89a5ad375a7cc3dd70
BLAKE2b-256 4c8f8341a04c3f6aae25544d0be87a458c4d538f268c48aaeb609af38f867a8a

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