Team Overbye Weather Data

Getting Started

  • Installation
    • Requirements
    • Install from PyPI
      • In a Jupyter notebook
    • Verify the install
    • Install for development
    • Pointing at a different backend
    • Upgrading
  • Quick Example
    • 1. Connect
    • 2. See what is available
    • 3. Download a whole file
    • 4. Crop to a region
    • 5. Crop in time as well
    • 6. Check what you got
    • Putting it together
    • Where to go next

Guides

  • Browsing the Catalog
    • Sources and types
      • ERA5 — reanalysis
      • HRRR — high-resolution CONUS
      • NOAA / GFS — forecasts
      • Extreme — curated historical events
    • Listing dates
    • Checking a specific date exists
    • The raw catalog
    • Caching
  • Downloading Data
    • One date
    • Many dates
    • File names
    • File formats
    • Progress bars
    • Choosing where files go
    • When the server is busy
    • Very large requests
    • Back-compatible methods
  • Cropping to a Region
    • By state
      • Several states
    • By ISO zone
    • By bounding box
    • Looking up the boxes
    • How cropping works
    • Size limits
  • Cropping in Time
    • A time window
    • One-sided windows
    • Times are UTC
    • Accepted formats
    • Time steps per source
    • Cropping time without cropping space
    • Requesting a window outside the file
    • Naming
  • Extreme Temperature Events
    • How events were selected
    • Finding an event
      • Event keys
    • Downloading event data
      • Several events at once
    • Animations
    • Coverage maps
    • Reading the data
    • A worked example
    • REST API
  • Working with PWW Files
    • Reading a file
    • The array
    • The header
    • Dates
    • Coordinates
    • Station records
    • Cropping locally
    • Writing a file
  • Troubleshooting
    • “No file for … “ (HTTP 404)
    • Empty list from list()
    • Empty ISO zone list
    • “Server queue full, retrying…”
    • “Server can’t crop … downloading in full”
    • “No time steps in requested range”
    • Downloaded file will not open in PowerWorld
    • Cropped file has fewer time steps than expected
    • Wrong region in the output
    • AttributeError: 'WeatherClient' object has no attribute 'extreme'
    • ImportError: No module named numpy
    • Connection timeouts
    • Status shows unknown for everything
    • Still stuck

API Reference

  • WeatherClient
    • WeatherClient
      • WeatherClient.status()
      • WeatherClient.catalog()
      • WeatherClient.sources()
      • WeatherClient.types()
      • WeatherClient.list()
      • WeatherClient.regions()
      • WeatherClient.region_ids()
      • WeatherClient.download()
  • Source Clients
    • Argument mapping
    • ERA5
      • ERA5Client
    • HRRR
      • HRRRClient
    • NOAA / GFS
      • NOAAClient
    • Extreme events
      • ExtremeClient
  • PWW I/O
    • Conventions
    • pww_io
      • read_pww()
      • read_pww_file()
      • crop_to_bbox()
      • concat_time()
      • write_pww()
      • crop_to_timerange()
    • localcrop
      • crop_file()
  • Exceptions
    • WeatherAPIError
      • WeatherAPIError.status
      • WeatherAPIError.detail
    • RegionTooLargeError
    • ServerBusyError
  • REST API
    • Endpoints
    • /api/catalog
    • /api/download
    • /api/download/region
    • /api/extreme/video
    • /api/extreme/coverage
    • /api/regions
    • Status codes
    • Rate limiting
    • Debug endpoints

Development

  • Architecture
    • Overview
    • Repository layout
    • Three places that must agree
    • The crop pipeline
    • Concurrency and load shedding
    • Why cropping is server-side
    • Deployment
  • Contributing
    • Local setup
    • Building the docs
    • Adding a data source
    • Things that will bite you
    • Testing a change to the crop path
    • Publishing
    • Style
Team Overbye Weather Data
  • Search

© Copyright Texas A&M University, Team Overbye.

Built with Sphinx using a theme provided by Read the Docs.