==> Quick Start <==

Let's get started very quick. Installation and basic configuration is done in a few minutes.

There are no real system requirements. You just need a current WeeWX installation.

If you want to use the Almanac page you need to install the pyephem package. Either via package manager, e.g.

sudo apt install python3-ephem

or via python's package manager

pip install pyephem

(or pip3, depending on your system).

->> Installation <<-

You can install NeoWX Material like any other WeeWX extension.

  1. Download the latest version from the project's website
  2. Place the downloaded zip-file on your device which is running weewx
  3. Run the wee_extension command below.
    If you installed WeeWX via package manager this should be in your $PATH.
    If you installed WeeWX manually, wee_extension is found in weewx's bin directory.
    In most cases: /home/weewx/bin
    wee_extension --install=path/to/neowx-material-latest.zip
  4. Now NeoWX Material is installed. You just need to set it as your report skin in your weewx.conf.
    In the [StdReport] section find your report and set skin = neowx-material.
  5. Go through the skin.conf and adjust it how you want. You will find the skin.conf in your weewx installation dir: skins/neowx-material
  6. Finally restart WeeWX: sudo service weewx restart

Now the reports will be generated with the NeoWX Material skin.

If you had a different skin before please read the next section.

If the automatic installation does not work you can check out the manual installation on the next page.

->> Clean up after skin change <<-

If you've used a different skin before it makes sense to cleanup the HTML_ROOT.

It's also possible that some files are missing because they are only copied once or generated at specific times.

In these cases we will clean the HTML_ROOT and let weewx re-generate everything.

  1. Stop weewx: sudo service weewx stop
  2. Remove all files from the HTML_ROOT where all files from your NeoWX Material report get copied to.
  3. Let WeeWX re-generate all missing files (which are all reports, archives included) and also copy all missing asset files (e.g. CSS, JS, font, images):
    wee_reports
    If this command isn't available in your $PATH you can find it in weewx's bin directory, like wee_extension above). Note that this can take a while because the whole archive will be re-generated!
  4. Start weewx again: sudo service weewx start

->> Uninstall <<-

To uninstall this skin simply use wee_extension again:

wee_extension --uninstall=neowx-material

If this doesn't work or you installed NeoWX Material manually you can easily uninstall it manually too:

  1. Stop weewx: sudo service weewx stop
  2. Edit your weewx.conf and set the skin of your reports to an existing one
  3. Remove the /path/to/weewx/skins/neowx-material directory.
  4. Start weewx: sudo service weewx start