USNAN SDK Documentation

Welcome to the USNAN SDK documentation. The USNAN SDK is a Python library that provides tools for working with USNAN (United States Network for Advanced NMR) data. Specifically, it provides dataclasses that map to data in the NAN archive, and provides an API client to fetch them.

It supports fetching public data records without authentication. Users with NMRHub accounts can authenticate to access additional datasets according to their credentials.

Contents:

• Quick Start
  • Installation
  • Basic Usage
  • Authentication
  • Next Steps
• Authentication
  • Browser Login
  • Device Login
  • Direct Token
  • Session Persistence
  • Logging Out
  • Error Handling
• API Reference
  • Overview
  • Dataset Fetch Endpoint
  • Dataset Search Endpoint
  • Facilities Endpoints
  • Spectrometers Endpoints
  • Probes Endpoints
• Class Descriptions