Mmaciejewski at 17:41, 7 October 2025

2025-10-07T17:41:59Z

← Older revision		Revision as of 17:41, 7 October 2025
Line 1:		Line 1:
			{{SDK_navigation}}
	= '''API Reference''' =		= '''API Reference''' =

Mmaciejewski: Created page with "= '''API Reference''' = This section summarizes the main classes and methods exposed by the SDK. == '''usnan.USNANClient''' == The central interface to the API. '''Constructor:''' client = usnan.USNANClient(base_url=None, timeout=30, num_retries=3) '''Attributes:''' * '''datasets''' – interface for dataset retrieval and search * '''facilities''' – interface for facility data * '''spectrometers''' – interface fo..."

2025-10-07T17:30:21Z

Created page with "= '''API Reference''' = This section summarizes the main classes and methods exposed by the SDK. == '''usnan.USNANClient''' == The central interface to the API. '''Constructor:''' <syntaxhighlight lang="python"> client = usnan.USNANClient(base_url=None, timeout=30, num_retries=3) </syntaxhighlight> '''Attributes:''' * '''datasets''' – interface for dataset retrieval and search * '''facilities''' – interface for facility data * '''spectrometers''' – interface fo..."

New page

= '''API Reference''' =

This section summarizes the main classes and methods exposed by the SDK.

== '''usnan.USNANClient''' ==
The central interface to the API.

'''Constructor:'''
<syntaxhighlight lang="python">
client = usnan.USNANClient(base_url=None, timeout=30, num_retries=3)
</syntaxhighlight>

'''Attributes:'''
* '''datasets''' – interface for dataset retrieval and search
* '''facilities''' – interface for facility data
* '''spectrometers''' – interface for spectrometer data
* '''probes''' – interface for probe metadata

== '''Datasets API''' ==
<syntaxhighlight lang="python">
ds = client.datasets.get(363067)
</syntaxhighlight>

Methods:
* '''get(id)''' – retrieve dataset by ID
* '''search(SearchConfig)''' – iterate over search results
* '''download(ids, location="path")''' – download datasets to a local folder

Dataset objects expose:
* '''id'''
* '''title'''
* '''experiment_name'''
* '''num_dimension'''
* '''spectrometer_identifier'''
* '''facility_identifier'''
* '''public_time'''

== '''Facilities API''' ==
<syntaxhighlight lang="python">
fac = client.facilities.get("UCHC-Mullen")
fac.spectrometers
fac.probes
</syntaxhighlight>

== '''SearchConfig''' ==
Defines dataset search criteria.

<syntaxhighlight lang="python">
cfg = usnan.models.SearchConfig(records=100)
cfg.add_filter("is_knowledgebase", value=True, match_mode="equals")
cfg.add_filter("num_dimension", value=3, match_mode="equals")
</syntaxhighlight>

Parameters:
* '''field''' – name of dataset attribute
* '''value''' – filter value
* '''match_mode''' – comparison type (equals, contains, greater, less)
* '''operator''' – logical combination (AND, OR)

USNAN Python SDK/API Reference - Revision history

Mmaciejewski at 17:41, 7 October 2025