Stand-alone

The client is given the login credentials, along with the station name and any API URIs that it needs to connect.

import dmax

client = dmax.Client(
    username="spam",
    password="secret",
    station_name="255IDZ",
    scheduling_uri: str = "https://example.com:11337",
    data_storage_uri: str = "https://example.com:22237",
    processing_uri: str = "https://example.com:55536",
)

proposals = client.proposals(cycle="2026-3")

experiments = client.experiments()
experiment = client.experiment(name="cabana-2026-3")

If the URI’s are omitted, the client will attempt to guess sensible defaults from the station name, for example station_name=”255IDZ” will produce URIs like https://s255idzdm.xray.aps.anl.gov:55536.

Embedded in a DM Environment

The APS data management system uses an extensive set of environmental variables to handle the API parameters. If any parameters or not provided to the client, environmental variables will be used if available:

import dmax

client = dmax.Client()

esafs = client.esafs(year=2026)