NeuroPACS Python SDK
Project description
NeuroPACS Python SDK
Connect to NeuroPACS diagnostic capabilities with our Python SDK.
Getting Started
Installation
pip install neuropacs
Usage
import neuropacs
api_key = "your_api_key"
server_url = "https://your_neuropacs_url"
product_id = "PD/MSA/PSP-v1.0"
prediction_format = "XML"
# PRINT CURRENT VERSION
version = neuropacs.PACKAGE_VERSION
#INITIALIZE NEUROPACS SDK
npcs = neuropacs.init(server_url, api_key)
#CONNECT TO NEUROPACS
connection = npcs.connect()
#CREATE A NEW JOB
order_id = npcs.new_job()
#UPLOAD AN IMAGE
# --> data must be a valid path <String> or byte array <Bytes>
# --> order_id param is optional
upload_status = npcs.upload(data)
#UPLOAD A DATASET
# --> dataset_path must be a valid path to a dataset <String>
# --> order_id param is optional
upload_status = npcs.upload_dataset(dataset_path)
#START A JOB
# --> Valid product_id options: PD/MSA/PSP-v1.0
# --> order_id param is optional
job_start_status = npcs.run_job(product_id)
#CHECK JOB STATUS
# --> order_id param is optional
job_status = npcs.check_status()
#RETRIEVE JOB RESULTS
# --> Valid prediction_format options: TXT, PDF, XML, JSON, DICOMSR
# --> order_id param is optional
job_results = npcs.get_results(prediction_format)
Authors
Kerrick Cavanaugh - kerrick@neuropacs.com
Version History
- 1.3.9
- Initial Release
- See release history
License
This project is licensed under the MIT License - see the LICENSE.md file for details
Project details
Release history Release notifications | RSS feed
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.4.8.tar.gz
(12.8 kB
view hashes)
Built Distribution
neuropacs-1.4.8-py3-none-any.whl
(12.8 kB
view hashes)
Close
Hashes for neuropacs-1.4.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf4fb9180f0318843beb85d1bdb529c767473394a2b8c4193d2ccce8307a5116 |
|
MD5 | 92f97fa7680ce2d86e7335c42d72f480 |
|
BLAKE2b-256 | 2a13882259bc215715992d0644899d55c3cebfdce0eda5227c7bb037d1014fa8 |