Skip to main content

Getting Started

1. Explore the Frontend​

Browse available data at the production data platform.

2. Install the Python Client​

pixi add vxdata-sdk

3. Connect​

from vxdata.sdk import Client

client = Client()

This logs a successful connection and shows where credentials were loaded from. Connection configuration and credentials are attempted to be loaded from the following sources in order:

  1. Passed explicitly to Client (e.g. Client(base_url="http://demo.data.virdx.dev/api"))
  2. Passed as environment variables (API_URL=...)

4. Load Data​

Query specific resource types using typed namespaces:

from vxdata.sdk import F

patients = client.patients.query().collect()
volumes = client.volumes.query().filter(F.volume_type == "T2").collect()
rpe = client.pathology_specimens.query().filter(F.type == "RPE").collect()

These return Polars DataFrames. Blob data (MRIs, etc.) appears as S3 paths — see accessing data for how to download files.

Next Steps​