Skip to content

fetch

Module for fetching structures from PDBe.

fetch(ids, save_dir, max_parallel_downloads=5, cacher=None) async

Fetches mmCIF files from the PDBe database.

Parameters:

Name Type Description Default
ids Iterable[str]

A set of PDB IDs to fetch.

required
save_dir Path

The directory to save the fetched mmCIF files to.

required
max_parallel_downloads int

The maximum number of parallel downloads.

5
cacher Cacher | None

An optional cacher to use for caching downloaded files.

None

Returns:

Type Description
Mapping[str, Path]

A dict of id and paths to the downloaded mmCIF files.

sync_fetch(ids, save_dir, max_parallel_downloads=5)

Synchronously fetches mmCIF files from the PDBe database.

Parameters:

Name Type Description Default
ids Iterable[str]

A set of PDB IDs to fetch.

required
save_dir Path

The directory to save the fetched mmCIF files to.

required
max_parallel_downloads int

The maximum number of parallel downloads.

5

Returns:

Type Description
Mapping[str, Path]

A dict of id and paths to the downloaded mmCIF files.