EarthScope SDK Documentation

EarthScope SDK Documentation#

Overview#

The EarthScope Software Development Kit (SDK) provides a powerful and intuitive interface for accessing and working with NSF SAGE and GAGE data repositories. Built with Python, it offers both synchronous and asynchronous interfaces to accommodate various use cases and performance requirements.

Quick Start#

Install the SDK using pip:

pip install earthscope-sdk

Or with optional dependencies:

# install arrow dependencies for efficient data access
pip install earthscope-sdk[arrow]

Basic usage example:

from earthscope_sdk import EarthScopeClient

# Initialize the client
client = EarthScopeClient()

# Get your user profile
profile = client.user.get_profile()
print(f"Welcome, {profile['name']}!")

Getting Help#

  • Documentation: Browse through our guides and tutorials

  • Examples: Check out our example notebooks and code snippets

  • Support: Contact us at data-help@earthscope.org

  • Issues: Report bugs or request features on our GitLab repository

Contributing#

We welcome contributions to the EarthScope SDK! Whether you’re fixing bugs, adding features, or improving documentation, your help is appreciated.

License#

The EarthScope SDK is licensed under the Apache License 2.0. See the LICENSE file for details.

Contents