mirror of
https://github.com/weewx/weewx.git
synced 2026-04-18 00:26:57 -04:00
<!DOCTYPE html>
<html lang="en">
<head>
<title>weewx: Documentation</title>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<link rel="stylesheet" href="css/weewx_ui.css"/>
<link rel="icon" href="images/favicon.png" type="image/png"/>
</head>
<body>
<div class="sidebar">
<div class="doclist">
<a href="usersguide.htm">User's Guide</a><br/>
<a href="customizing.htm">Customization Guide</a><br/>
<a href="hardware.htm">Hardware Guide</a><br/>
<a href="utilities.htm">Utilities Guide</a><br/>
<a href="upgrading.htm">Upgrade Guide</a><br/>
<a href="devnotes.htm">Notes for Developers</a>
</div>
</div>
<div class="main">
<div class="header">
<div class="logoref">
<a href='https://weewx.com'> <img src='images/logo-weewx.png' class='logo' style="float:right" alt="weewx logo"/>
</a><br/> <span class='version'>
Version: 4.3
</span>
</div>
<div class="title">WeeWX Documentation</div>
</div>
<div class="content">
<dl>
<dt>Quick-Start</dt>
<dd>
Follow the installation instructions for a basic install, which
you can then refine. For detailed instructions, see the
User's Guide.
<p>
<a href="debian.htm">Instructions for Debian, Ubuntu, Mint, Raspbian</a><br/>
<a href="redhat.htm">Instructions for Redhat, Centos, Fedora</a><br/>
<a href="suse.htm">Instructions for SUSE, OpenSUSE</a><br/>
<a href="macos.htm">Instructions for MacOS</a><br/>
<a href="setup.htm">Instructions using setup.py</a><br/>
</p>
</dd>
<dt><a href="usersguide.htm">User's Guide</a></dt>
<dd>
Contains complete details about how to install, configure, and
run WeeWX. Includes instructions for
migrating from <span class="code">wview</span>, integrating
WeeWX with a web server, uploading to
various weather services, and troubleshooting. This is the
definitive guide to using WeeWX.
</dd>
<dt><a href="customizing.htm">Customization Guide</a></dt>
<dd>
Describes how to modify reports through configuration
options and templates. Explains how to create and
customize skins. Also includes more advanced topics such as
creating custom generators and services, adding new template
tags, and creating drivers for new weather station hardware.
</dd>
<dt><a href="hardware.htm">Hardware Guide</a></dt>
<dd>
Includes capabilities and quirks of hardware that is directly
supported by WeeWX. This guide
describes how to configure each type of hardware using the
<span class="code">wee_device</span> utility. It also includes
a driver compatibility table that shows which drivers work with
what hardware, and the capability level of each driver.
</dd>
<dt><a href="utilities.htm">Utilities Guide</a></dt>
<dd>
Reference for the various utilities that are included with
WeeWX. This guide contains details
about the options for each utility, as well of examples of how
to use the utilities. The programs include an import utility,
a database utility, a tool to configure weather station
hardware, and a tool to upload missing data to
Weather Underground.
</dd>
<dt><a href="upgrading.htm">Upgrade Guide</a></dt>
<dd>
Instructions for upgrading from previous versions of WeeWX.
</dd>
<dt><a href="devnotes.htm">Notes for Developers</a></dt>
<dd>
Outline of the goals and strategies for
WeeWX. This guide provides
the guidelines for how WeeWX
developers should deal with issues such as time,
internationalization, exception handling, and units.
</dd>
<dt><a href="changes.txt">Change Log</a></dt>
<dd>List of the changes in each release.</dd>
<dt><a href="https://weewx.com/hwcmp.html">Hardware Comparison</a></dt>
<dd>Are you looking for a weather station? Would you like to
build your own station? This table lists the sensors,
configurations, and specifications for various
types of weather-related hardware.
</dd>
</dl>
</div>
</div>
<div class="footer">
<p class='copyright'>
© <a href='copyright.htm'>Copyright</a> Tom Keffer
</p>
</div>
</body>
</html>