Mmaciejewski at 17:41, 7 October 2025

2025-10-07T17:41:47Z

← Older revision		Revision as of 17:41, 7 October 2025
Line 1:		Line 1:
			{{SDK_navigation}}
	= '''Getting Started with the USNAN Python SDK''' =		= '''Getting Started with the USNAN Python SDK''' =

Mmaciejewski: Created page with "= '''Getting Started with the USNAN Python SDK''' = == '''Creating a Client''' == The core entry point is the '''USNANClient''' class. import usnan client = usnan.USNANClient() By default, it connects to the public API at: https://dev.api.nmrhub.org Optional parameters: * '''base_url''' – override the API endpoint * '''timeout''' – request timeout in seconds * '''num_retries''..."

2025-10-07T17:28:03Z

Created page with "= '''Getting Started with the USNAN Python SDK''' = == '''Creating a Client''' == The core entry point is the '''USNANClient''' class. <syntaxhighlight lang="python"> import usnan client = usnan.USNANClient() </syntaxhighlight> By default, it connects to the public API at: <syntaxhighlight> https://dev.api.nmrhub.org </syntaxhighlight> Optional parameters: * '''base_url''' – override the API endpoint * '''timeout''' – request timeout in seconds * '''num_retries''..."

New page

= '''Getting Started with the USNAN Python SDK''' =

== '''Creating a Client''' ==
The core entry point is the '''USNANClient''' class.

<syntaxhighlight lang="python">
import usnan
client = usnan.USNANClient()
</syntaxhighlight>

By default, it connects to the public API at:
<syntaxhighlight>
https://dev.api.nmrhub.org
</syntaxhighlight>

Optional parameters:
* '''base_url''' – override the API endpoint
* '''timeout''' – request timeout in seconds
* '''num_retries''' – automatic retry attempts

== '''Listing Facilities''' ==
<syntaxhighlight lang="python">
for fac in client.facilities.list():
print(fac.identifier, fac.long_name)
</syntaxhighlight>

Each facility exposes linked spectrometers and probes.

== '''Searching for Datasets''' ==
<syntaxhighlight lang="python">
cfg = (
usnan.models.SearchConfig(records=50)
.add_filter("is_knowledgebase", value=True, match_mode="equals")
.add_filter("num_dimension", value=2, match_mode="equals")
)

for ds in client.datasets.search(cfg):
print(ds.id, ds.title, ds.num_dimension)
</syntaxhighlight>

== '''Downloading Datasets''' ==
<syntaxhighlight lang="python">
client.datasets.download([363067], location="data/")
</syntaxhighlight>

Files are stored in a directory structure mirroring dataset identifiers.

== '''Caching and Error Handling''' ==
The SDK caches facilities, spectrometers, and probes for efficiency.
To refresh the cache:

<syntaxhighlight lang="python">
client.clear_cache()
</syntaxhighlight>

Common exceptions:
* '''TypeError''' – invalid argument types
* '''KeyError''' – missing entity ID
* '''ValueError''' – inconsistent filter operators

USNAN Python SDK/Getting Started - Revision history

Mmaciejewski at 17:41, 7 October 2025