synopticpy

Retrieve mesonet weather data as Polars DataFrames from Synoptic's Weather API.

https://github.com/blaylockbk/synopticpy

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
✓
Academic publication links
Links to: zenodo.org
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (12.3%) to scientific vocabulary

Keywords

mesonet mesowest polars python synoptic-api weather

Keywords from Contributors

neutron

Last synced: 6 months ago · JSON representation ·

Repository

Retrieve mesonet weather data as Polars DataFrames from Synoptic's Weather API.

Basic Info

Host: GitHub
Owner: blaylockbk
License: mit
Language: Python
Default Branch: main
Homepage: https://synopticpy.readthedocs.io/
Size: 35.8 MB

Statistics

Stars: 70
Watchers: 3
Forks: 6
Open Issues: 4
Releases: 7

Topics

mesonet mesowest polars python synoptic-api weather

Created over 5 years ago · Last pushed about 1 year ago

Metadata Files

Readme License Citation

README.md

<div align='center'

Shows a black logo in light color mode and a white one in dark color mode.

Synoptic API for Python

License

📘 Documentation | 💬 Discussions | 🚑 Issues

Synoptic's Weather API provides real-time and historical surface-based weather and environmental observations for thousands of mesonet stations, and the open-access data is free. More data and enhanced services may be purchased (from Synoptic, not me).

I'm a Synoptic user. I wrote this package to conveniently request data from Synoptic in a Pythonic way and convert its returned JSON to a Polars DataFrame.

```python from datetime import timedelta from synoptic import TimeSeries

df = TimeSeries( stid="wbb", recent=timedelta(minutes=30) ).df() ```

alt text

I'm sharing this package to improve my skills with Polars and gain more experience in building and maintaining open-source Python packages. If you came across this package, I hope you find it valuable.

Best of Luck 🍀
-Brian

🐍 Install

bash pip install SynopticPy

bash conda install -c conda-forge synopticpy

Configure Token

[!IMPORTANT]

🎟️ To use SynopticPy you need a Synoptic API token.

There are three ways you can configure your Synoptic API token:

Set an environment variable SYNOPTIC_TOKEN with your token. For example, in bash: bash export SYNOPTIC_TOKEN="yourTokenHere123456789"
Create a file ~/.config/SynopticPy/config.toml with the following toml token = "yourTokenHere123456789"
Pass your token whenever you use one of SynopticPy's classes. python TimeSeries( stid="wbb", recent=30, token="yourTokenHere123456789" )

How to Cite and Acknowledge

If SynopticPy played an important role in your work, please tell me about it! Also, consider including a citation or acknowledgement in your article or product.

Suggested Citation

Blaylock, B. K. (YEAR). SynopticPy: Synoptic API for Python (Version 20??.?.?) [Computer software]. https://github.com/blaylockbk/SynopticPy

Suggested Acknowledgment

A portion of this work used code generously provided by Brian Blaylock's SynopticPy Python package (https://github.com/blaylockbk/SynopticPy)

[!TIP]

📈 See also my SynopticPy Web App which lets you plot station data in your browser powered by pyscript!

Owner

Name: Brian Blaylock
Login: blaylockbk
Kind: user
Location: Monterey, CA

Website: http://home.chpc.utah.edu/~u0553130/Brian_Blaylock/home.html
Twitter: blaylockbk
Repositories: 45
Profile: https://github.com/blaylockbk

Meteorologist

Citation (CITATION.cff)

cff-version: 1.2.0
abstract: The Synoptic Weather API gives access to real-time and historical surface-based weather and environmental observations for thousands of stations. SynopticPy is a Python package that provides convenient access to data from the Synoptic API and convert the returned JSON data to a Polars DataFrame. This may be helpful to others who are getting started with the Synoptic API and Python.
message: "If you use this software, please cite it as below."
authors:
  - family-names: Blaylock
    given-names: Brian K.
    email: blaylockbk@gmail.com
    orcid: "https://orcid.org/0000-0003-2133-9313"
title: "SynopticPy: Synoptic API for Python"
version: 2024.11.0
date-released: "2024-11-09"
url: "https://synopticpy.readthedocs.io/"
repository-code: "https://github.com/blaylockbk/SynopticPy"
type: software
keywords:
  - meteorology
  - weather
  - atmosphere
license: "MIT"
identifiers:
  - type: doi
    value: 10.5281/zenodo.4567546

GitHub Events

Total

Create event: 5
Release event: 2
Issues event: 24
Watch event: 20
Delete event: 1
Issue comment event: 13
Push event: 79
Pull request event: 8

Last Year

Create event: 5
Release event: 2
Issues event: 24
Watch event: 20
Delete event: 1
Issue comment event: 13
Push event: 79
Pull request event: 8

Committers

Last synced: 7 months ago

All Time

Total Commits: 522
Total Committers: 6
Avg Commits per committer: 87.0
Development Distribution Score (DDS): 0.092

Past Year

Commits: 169
Committers: 1
Avg Commits per committer: 169.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
Brian Blaylock	b**k@g**m	474
Brian Blaylock	b**r@n**l	20
Nathan Blaylock	n**k@g**m	14
Weidav	d**r@g**m	11
Brian	=	2
The Gitter Badger	b**r@g**m	1

Committer Domains (Top 20 + Academic)

gitter.im: 1 nrlmry.navy.mil: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 37
Total pull requests: 21
Average time to close issues: 6 months
Average time to close pull requests: 5 days
Total issue authors: 10
Total pull request authors: 4
Average comments per issue: 1.14
Average comments per pull request: 0.52
Merged pull requests: 19
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 9
Pull requests: 10
Average time to close issues: 6 days
Average time to close pull requests: 12 days
Issue authors: 2
Pull request authors: 1
Average comments per issue: 0.44
Average comments per pull request: 0.3
Merged pull requests: 9
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

blaylockbk (27)
jh-206 (2)
ngblaylock (1)
hayesfj (1)
mysterefrank (1)
j0nes2k (1)
nick-dawson (1)
vandam60 (1)
dsjstc (1)
charliephillips4201 (1)

Pull Request Authors

blaylockbk (17)
Weidav (2)
gitter-badger (1)
ngblaylock (1)

Top Labels

Issue Labels

web app (6) bug (3) help wanted (2) enhancement (1) pyscript (1)

Pull Request Labels

web app (1)

Packages

Total packages: 1
Total downloads:
- pypi 3,777 last-month

Total dependent packages: 0
Total dependent repositories: 1
Total versions: 9
Total maintainers: 1

pypi.org: synopticpy

Retrieve mesonet weather data as Polars DataFrames from Synoptic's Weather API.

Homepage: https://github.com/blaylockbk/SynopticPy
Documentation: https://synopticpy.readthedocs.io/
License: MIT License Copyright (c) 2019-2024 Brian Blaylock Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Latest release: 2024.12.0
published about 1 year ago

Versions: 9
Dependent Packages: 0
Dependent Repositories: 1
Downloads: 3,777 Last month

Rankings

Dependent packages count: 7.3%

Stargazers count: 10.9%

Forks count: 12.0%

Average: 16.1%

Dependent repos count: 22.1%

Downloads: 28.4%

Maintainers (1)

blaylockbk

Last synced: 6 months ago

Dependencies

.github/workflows/static.yml actions

actions/checkout v3 composite
actions/configure-pages v3 composite
actions/deploy-pages v2 composite
actions/setup-node v3 composite
actions/upload-pages-artifact v1 composite

11ty-site/package-lock.json npm

249 dependencies

11ty-site/package.json npm

@11ty/eleventy ^2.0.1 development
@sherby/eleventy-plugin-files-minifier ^1.1.1 development
cross-env ^7.0.3 development
rimraf ^5.0.1 development

pyproject.toml pypi

.github/workflows/release_to_pypi.yml actions

actions/checkout v4 composite
actions/setup-python v5 composite
pypa/gh-action-pypi-publish release/v1 composite

.github/workflows/tests-python.yml actions

actions/checkout v4 composite
actions/setup-python v5 composite

requirements-test.txt pypi

pytest <8 test

environment.yml conda

altair
cartopy
git
great_tables
isort
jupyter
matplotlib
metpy
nodejs
numpy
pandas
pip
polars
pyarrow
pytest
pytest-cov
python 3.13.*
requests
ruff
scikit-image
seaborn