Skip to main content

neuropacs Python API

Project description

Integration Tests CodeQL

neuropacs™ Python API

Connect to neuropacs™ diagnostic capabilities with our Python API.

Getting Started

Installation

pip install neuropacs

Usage

import neuropacs

api_key = "api_key"
server_url = "neuropacs_url"
product_name = "Atypical/MSAp/PSP-v1.0"
prediction_format = "XML"
origin_type = "my_application"

# INITIALIZE NEUROPACS API
npcs = neuropacs.init(server_url=server_url, api_key=api_key, origin_type=origin_type)

# CONNECT TO NEUROPACS
connection = npcs.connect()

# CREATE A NEW JOB
order_id = npcs.new_job()

# UPLOAD A DATASET
upload_status = npcs_admin.upload_dataset_from_path(order_id=order_id,  path="/path/to/dataset/")

# START A JOB
# --> Valid product_name options: Atypical/MSAp/PSP-v1.0
job_start_status = npcs.run_job(order_id=order_id, product_name=product_name)

# CHECK JOB STATUS
job_status = npcs.check_status(order_id=order_id)

# RETRIEVE JOB RESULTS
# --> Valid prediction_format options: TXT, PDF, XML, PNG
job_results = npcs.get_results(order_id=order_id, prediction_format=prediction_format)

Authors

Kerrick Cavanaugh - kerrick@neuropacs.com

Version History

License

This project is licensed under the MIT License - see the LICENSE.md file for details

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

neuropacs-1.8.4.tar.gz (11.7 kB view details)

Uploaded Source

Built Distribution

neuropacs-1.8.4-py3-none-any.whl (11.8 kB view details)

Uploaded Python 3

File details

Details for the file neuropacs-1.8.4.tar.gz.

File metadata

  • Download URL: neuropacs-1.8.4.tar.gz
  • Upload date:
  • Size: 11.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.6

File hashes

Hashes for neuropacs-1.8.4.tar.gz
Algorithm Hash digest
SHA256 74fe20b5d0779edb6fd1e82db15bc8aaa0a7f511f39c357486ad5adecebfa752
MD5 fe888accb3b0bcc037b5a94c091aa5fc
BLAKE2b-256 93d988c68217c4a255d6e87714b9924355ffd2e4927e078888f95ae1a0e1ea90

See more details on using hashes here.

File details

Details for the file neuropacs-1.8.4-py3-none-any.whl.

File metadata

  • Download URL: neuropacs-1.8.4-py3-none-any.whl
  • Upload date:
  • Size: 11.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.6

File hashes

Hashes for neuropacs-1.8.4-py3-none-any.whl
Algorithm Hash digest
SHA256 bfd24bfdaf39a772a04758787e9f712f8c89b94e15bdc4744b92134f5ad30131
MD5 bbe78335cafd142cc64ffe720f45dad1
BLAKE2b-256 fa3b3adc5721394d293ccc11f930eb6ba791c4e26cef40b9ed7affbbb103b554

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