Installation

Prerequisites

Build the Docker image

Clone the neuropacs-cli repository and build from the Dockerfile


    # Clone the repository using Git
    git clone https://github.com/neuropacs/neuropacs-cli.git

    # Navigate to the neuropacs-cli project
    cd /path/to/neuropacs-cli/

    # Build the Docker image from the Dockerfile
    docker build . --no-cache --build-arg server_url=SERVER_URL --build-arg api_key=API_KEY -t neuropacs

Usage

Example

Working example using the neuropacs™ CLI.


    # Create a session
    docker run --rm neuropacs connect

    # Create a new order
    docker run --rm neuropacs new-job

    # Upload a dataset via path (hint: use '-v' flag for verbose mode)
    docker run --rm -v /local/path/to/dataset/:/data neuropacs upload-dataset-from-path (-v) --order-id ORDER_ID

    # Start an order
    docker run --rm neuropacs run-job --order-id ORDER_ID --product PRODUCT_ID 

    # Check order status
    docker run --rm neuropacs check-status --order-id ORDER_ID

    # Retrieve job results
    docker run --rm neuropacs get-results --order-id ORDER_ID --format FORMAT

DICOMweb Integration

The API retrieves and processes images directly from DICOMweb-compliant servers via WADO-RS, enabling neuropacs™ analysis for streamlined diagnostic workflows.


    # Upload a dataset via a DICOMweb WADO-RS server w/ credentials (hint: use '-v' flag for verbose mode)
    docker run --rm neuropacs upload-dataset-from-dicom-web (-v) --order-id ORDER_ID --wado-url WADO_URL --study-uid STUDY_UID --username USERNAME --password PASSWORD

    # Upload a dataset via a DICOMweb WAD-RS server w/out credentials (hint: use '-v' flag for verbose mode)
    docker run --rm neuropacs upload-dataset-from-dicom-web (-v) --order-id ORDER_ID --wado-url WADO_URL --study-uid STUDY_UID

    # NOTE: If your DICOMweb WADO-RS server is hosted locally, replace "localhost" with "host.docker.internal".
         # Ex. "http://localhost:8080/dcm4chee-arc/aets/DCM4CHEE/rs" -> "http://host.docker.internal:8080/dcm4chee-arc/aets/DCM4CHEE/rs"

NOTE: To view the help screen of any command, use the '-h' or '--help' flag (ex. sudo docker run --rm neuropacs connect -h).

Contact

Kerrick Cavanaugh (Lead Software Engineer) - kerrick@neuropacs.com

License

This project is licensed under the MIT.

Explore

Integrations

Explore the different systems and software that our product integrates with. Click each integration for detailed setup and usage instructions.

Supported Programming Languages

Our product supports various programming languages to offer flexibility in development. Click each language for APIs, libraries, and examples.