Skip to main content

Getting Started

The VirDx Dashboard provides a user interface to explore available data, make sure to look through it at dashboard.fra.virdx.dev/.

All data can be accessed in your Python codebases using the vxData SDK:

pixi add vxdata-sdk

installs the Python client.

All interactions here run through the client object:

from vxdata.sdk import Client

client = Client()

This should now log a successful connection and show where credentials were loaded from.

tip

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="https://data.fra.virdx.dev/"))
  2. Passed as environment variables (API_URL=...)

By default, the client tries to connect to https://data.fra.virdx.dev/.

You're now set up to start accessing data! Make sure to read the data reading guide next.