USNAN Python SDK - Revision history

Mmaciejewski at 17:34, 7 October 2025

2025-10-07T17:34:38Z

← Older revision		Revision as of 17:34, 7 October 2025
Line 1:		Line 1:
	{{~~USNAN_SDK_Navbox~~}}		{{SDK_navigation}}
	= '''USNAN Python SDK''' =		= '''USNAN Python SDK''' =

Mmaciejewski at 17:34, 7 October 2025

2025-10-07T17:34:10Z

← Older revision		Revision as of 17:34, 7 October 2025
Line 1:		Line 1:
			{{USNAN_SDK_Navbox}}
	= '''USNAN Python SDK''' =		= '''USNAN Python SDK''' =

Mmaciejewski at 17:26, 7 October 2025

2025-10-07T17:26:05Z

← Older revision		Revision as of 17:26, 7 October 2025
Line 3:		Line 3:
	The '''USNAN Python SDK''' provides programmatic access to data and metadata from the USNAN Network API. It enables researchers to discover, query, and download datasets, as well as navigate between related entities such as facilities, spectrometers, probes, and knowledgebase resources.		The '''USNAN Python SDK''' provides programmatic access to data and metadata from the USNAN Network API. It enables researchers to discover, query, and download datasets, as well as navigate between related entities such as facilities, spectrometers, probes, and knowledgebase resources.

	This SDK complements the [[~~USNAN Data Browser~~]] and other web tools available through the USNAN web portal, offering a scripting interface for automation, reproducibility, and integration into computational workflows.		This SDK complements the [[Data_Browser]] and other web tools available through the USNAN web portal, offering a scripting interface for automation, reproducibility, and integration into computational workflows.

	== '''Overview''' ==		== '''Overview''' ==

Mmaciejewski: Created page with "= '''USNAN Python SDK''' = The '''USNAN Python SDK''' provides programmatic access to data and metadata from the USNAN Network API. It enables researchers to discover, query, and download datasets, as well as navigate between related entities such as facilities, spectrometers, probes, and knowledgebase resources. This SDK complements the USNAN Data Browser and other web tools available through the USNAN web portal, offering a scripting interface for automation, rep..."

2025-10-07T17:22:22Z

Created page with "= '''USNAN Python SDK''' = The '''USNAN Python SDK''' provides programmatic access to data and metadata from the USNAN Network API. It enables researchers to discover, query, and download datasets, as well as navigate between related entities such as facilities, spectrometers, probes, and knowledgebase resources. This SDK complements the USNAN Data Browser and other web tools available through the USNAN web portal, offering a scripting interface for automation, rep..."

New page

= '''USNAN Python SDK''' =

The '''USNAN Python SDK''' provides programmatic access to data and metadata from the USNAN Network API. It enables researchers to discover, query, and download datasets, as well as navigate between related entities such as facilities, spectrometers, probes, and knowledgebase resources.

This SDK complements the [[USNAN Data Browser]] and other web tools available through the USNAN web portal, offering a scripting interface for automation, reproducibility, and integration into computational workflows.

== '''Overview''' ==
The SDK wraps the RESTful API available at https://api.nmrhub.org/ and provides convenient Python classes for accessing:
* Datasets
* Facilities
* Spectrometers
* Probes
* Knowledgebase (KB) records

The SDK performs lazy fetching of linked objects, provides caching for repeated queries, and includes methods for dataset download and filtering.

== '''Installation''' ==
The SDK is available from PyPI.

<syntaxhighlight lang="bash">
pip install usnan
</syntaxhighlight>

or install directly from GitHub for the latest version:

<syntaxhighlight lang="bash">
pip install git+https://github.com/NanNMR/PythonSDK.git
</syntaxhighlight>

== '''Quick Start''' ==
<syntaxhighlight lang="python">
import usnan

client = usnan.USNANClient()

# Get facility information
mullen = client.facilities.get("UCHC-Mullen")
print(mullen.long_name)

# Search datasets
search = (
usnan.models.SearchConfig(records=10)
.add_filter("is_knowledgebase", value=True, match_mode="equals")
)
for ds in client.datasets.search(search):
print(ds.id, ds.title)

# Download a dataset
client.datasets.download([ds.id for ds in client.datasets.search(search)], location="downloads")
</syntaxhighlight>

== '''Links''' ==
* [[USNAN_Python_SDK/Getting_Started|Getting Started]]
* [[USNAN_Python_SDK/API_Reference|API Reference]]
* [[USNAN_Python_SDK/Examples|Examples]]
* [https://github.com/NanNMR/PythonSDK GitHub Repository]
* [https://pythonsdk.readthedocs.io/en/latest/ Read the Docs Documentation]

== '''License''' ==
The SDK is released under the MIT License.

== '''Contact''' ==
For questions, please contact the USNAN development team at support@usnan.org.