Skip to content

Introduction to WeeWX

The WeeWX weather system is written in Python and runs on Linux, MacOSX, Solaris, and *BSD. It collects data from many types of weather stations and sensors, then generates plots, HTML pages, and monthly and yearly summary reports. It can push plots, pages, and reports to a web server, and data to many online weather services.

Initial development began in the winter of 2008-2009, with the first release in 2009. WeeWX is about 25,000 lines of code, plus another 15,000 for the hardware drivers.

The source code is hosted on GitHub. Installation instructions and releases are available at weewx.com/downloads.

See the hardware list for a complete list of supported stations, and for pictures to help identify your hardware! The hardware comparison shows specifications for many types of hardware, including some not yet supported by WeeWX.

The WeeWX distribution includes drivers for many types of hardware. These are listed in the driver list in the Hardware Guide. See the WeeWX Wiki for additional drivers and other extensions.

Installation

If you're an old hand at installing software on Unix systems, you may be able to use one of our Quickstart guides:

  • Debian - including Ubuntu, Mint, Raspberry Pi OS, Devuan. Uses apt.
  • Redhat - including Fedora, CentOS, Rocky. Uses yum.
  • SUSE - including openSUSE. Uses zypper.
  • pip - any operating system. Uses pip
  • git - any operating system. Run directly from repository.

Otherwise, see the section Installing WeeWX in the User's Guide.

Documentation

WeeWX includes extensive documentation, and the WeeWX developers work hard to keep it relevant and up to date. If you have questions, please consult the documentation first.

  • User's Guide - installation, getting started, where to find things, backup/restore, troubleshooting
  • Customization Guide - instructions for customizing reports and plots, localization, formatting, writing extensions
  • Utilities Guide - tools to manage stations, reports, and data
  • Hardware Guide - how to configure hardware, features of supported hardware
  • Upgrade Guide - detailed changes in each release
  • Reference - application options, skin options, definition of units and unit systems
  • Notes for developers - things you should know if you write drivers or skins

Support

Please first try to solve any problems yourself by reading the documentation. If that fails, check the answers to frequently-asked questions, browse the latest guides and software in the WeeWX Wiki, or post a question to the WeeWX user group.

FAQ

The Frequently Asked Questions (FAQ) is contributed by WeeWX users. It contains pointers to more information for problems and questions most frequently asked in the WeeWX forums.

https://github.com/weewx/weewx/wiki/WeeWX-Frequently-Asked-Questions

Wiki

The wiki content is contributed by WeeWX users. It contains suggestions and experiences with different types of hardware, skins, extensions to WeeWX, and other useful tips and tricks.

https://github.com/weewx/weewx/wiki

Forums

weewx-user is for general issues such as installation, sharing skins and templates, reporting unexpected behavior, and suggestions for improvement.

weewx-development is for discussions about developing drivers, extensions, or working on the core code.

WeeWX is licensed under the GNU Public License v3.

© Copyright 2009-2024 Thomas Keffer, Matthew Wall, and Gary Roderick