🐍 Install

Install with conda:

conda install -c conda-forge SynopticPy

Install with pip:

pip install SynopticPy

Install latest from GitHub:

pip install git+https://github.com/blaylockbk/SynopticPy.git

For developers:

git clone https://github.com/blaylockbk/SynopticPy.git
cd SynopticPy
pip install -e .

Quick Start

Refer to the Setup page for additional instructions on getting and configuring your Synoptic API token.

Import SynopticPy by importing the synoptic module or importing the classes for individual services.

import synoptic

or

from synoptic import TimeSeries, Precipitation # etc.

You retrieve data as a DataFrame using the .df() method. For example:

import synoptic

df = synoptic.Latest(stid='wbb').df()

or

from synoptic import Latest

df = Latest(stid='wbb').df()