Running WeeWX from source¶
This is a guide to running WeeWX directly from the code. This approach is perhaps most appropriate for developers, but it is also useful on older operating systems or on platforms with tight memory and/or storage constraints.
Although you do not need root privileges to install and configure WeeWX, you will need them to set up a daemon and, perhaps, to change device permissions.
Pre-requisites¶
Ensure that Python 3.7 or later is installed.
Ensure that the following Python modules are installed:
- ConfigObj
- Cheetah
- PIL
You may also want the following Python modules:
- serial (if your hardware uses a serial port)
- usb (if your hardware uses a USB port)
- ephem (if you want extended celestial information)
Get the code¶
Use git
to clone the repository into a directory called weewx
in your home
directory.
git clone https://github.com/weewx/weewx ~/weewx
Note
For systems with very little space, download then expand a single release from https://weewx.com/downloads
Provision a new station¶
Now that you have the code, create a configuration file and skins:
python3 ~/weewx/bin/weectl.py station create
The tool weectl
will ask you a series of questions, then create a directory
weewx-data
in your home directory with a new configuration file. It will
also install skins, documentation, utilitiy files, and examples in the same
directory. The database and reports will also go into that directory, but
only after you run weewxd
, as shown in the following step.
Run weewxd
¶
The program weewxd
does the data collection, archiving, uploading, and report
generation. You can run it directly, or as a daemon.
When you run WeeWX directly, it will print data to the screen, and WeeWX will stop when you either control-c or log out.
python3 ~/weewx/bin/weewxd.py
To run weewxd
as a daemon, install an init file that is appropriate for your
operating system. Examples are included in the util
directory.
Verify¶
After about 5 minutes (the exact length of time depends on your archive interval), copy the following and paste into a web browser. You should see your station information and data.
~/weewx-data/public_html/index.html
If you have problems, check the system log for entries from weewxd
.
Customize¶
To enable uploads or to customize reports, modify the configuration file.
Use any text editor, such as nano
:
nano ~/weewx-data/weewx.conf
WeeWX must be restarted for the changes to take effect.
See the User Guide and Customization Guide for details.
Upgrade¶
Update the code by pulling the latest:
cd ~/weewx && git pull
Then restart weewxd
Uninstall¶
Before you uninstall, be sure that weewxd
is not running.
Then simply delete the code:
rm -r ~/weewx
If desired, delete the data directory:
rm -r ~/weewx-data