weewx/docs_src/usersguide/where.md

Where to find things

Locations

Here is a summary of the layout for the different install methods, along with the symbolic names used for each role. These names are used throughout the documentation.

!!! Note The install locations below are relative to WEEWX_ROOT. See Python's documentation on os.path.join() for the results of joining two absolute paths (summary: the 2nd path wins).

=== "Debian"

| Role                    | Symbolic name    | Nominal value                   |
|-------------------------|------------------|---------------------------------|
| WeeWX root directory    | _`WEEWX_ROOT`_   | `/`                             |
| Executables             | _`BIN_ROOT`_     | `/usr/share/weewx/`             |
| Configuration directory | _`CONFIG_ROOT`_  | `/etc/weewx/`                   |
| Skins and templates     | _`SKIN_ROOT`_    | `/etc/weewx/skins/`             |
| SQLite databases        | _`SQLITE_ROOT`_  | `/var/lib/weewx/`               |
| Web pages and images    | _`HTML_ROOT`_    | `/var/www/html/weewx/`          |
| Documentation           | _`DOC_ROOT`_     | `/usr/share/doc/weewx/`         |
| Examples                | _`EXAMPLE_ROOT`_ | `/usr/share/doc/weewx/examples/`|
| User directory          | _`USER_ROOT`_    | `/usr/share/weewx/user`         |

=== "RedHat/openSUSE"

| Role                    | Symbolic name    | Nominal value                          |
|-------------------------|------------------|----------------------------------------|
| WeeWX root directory    | _`WEEWX_ROOT`_   | `/`                                    |
| Executables             | _`BIN_ROOT`_     | `/usr/share/weewx/`                    |
| Configuration directory | _`CONFIG_ROOT`_  | `/etc/weewx/`                          |
| Skins and templates     | _`SKIN_ROOT`_    | `/etc/weewx/skins/`                    |
| SQLite databases        | _`SQLITE_ROOT`_  | `/var/lib/weewx/`                      |
| Web pages and images    | _`HTML_ROOT`_    | `/var/www/html/weewx/`                 |
| Documentation           | _`DOC_ROOT`_     | `/usr/share/doc/weewx-x.y.z/`          |
| Examples                | _`EXAMPLE_ROOT`_ | `/usr/share/doc/weewx-x.y.z/examples/` |
| User directory          | _`USER_ROOT`_    | `/usr/share/weewx/user`                |

=== "Pip (including macOS)"

| Role                    | Symbolic name    | Nominal value        |
|-------------------------|------------------|----------------------|
| WeeWX root directory    | _`WEEWX_ROOT`_   | `~/weewx-data`       |
| Executables             | _`BIN_ROOT`_     | see below            |
| Configuration directory | _`CONFIG_ROOT`_  | `./`                 |
| Skins and templates     | _`SKIN_ROOT`_    | `./skins/`           |
| SQLite databases        | _`SQLITE_ROOT`_  | `./archive/`         |
| Web pages and images    | _`HTML_ROOT`_    | `./public_html/`     |
| Documentation           | _`DOC_ROOT`_     | `./docs`             |
| Examples                | _`EXAMPLE_ROOT`_ | `./examples/`        |
| User directory          | _`USER_ROOT`_    | `./bin/user`         |

Location of pip-installed executables

If you use a pip install, the location of the executables will depend on the details:

Install method	Commands	Location of executables
pip, no sudo, with --user (recommended)	pip3 install weewx --user	~/.local/bin/
pip, no sudo, no --user	pip3 install weewx	~/.local/bin/
pip with sudo (not recommended)	sudo pip3 install weewx	/usr/local/bin/ (1)
Virtual environment	python3 -m venv ve . ve/bin/activate pip3 install weewx	./ve/bin/
Virtual environment with --user	python3 -m venv ve . ve/bin/activate pip3 install weewx --user	Not allowed

(1) Checked on Ubuntu 22.02 and Rocky v9.1

Log files

Where to find your log file. You may require root permissions to read them.

=== "Debian"

`/var/log/syslog`

=== "RedHat/openSUSE"

`/var/log/messages`

=== "macOS"

The macOS log file is nominally found at `/var/log/syslog`. However, it is likely to contain
only severe log messages. You may want to consider logging to a rotating file. See the
wiki article [*Logging to rotating files*](https://github.com/weewx/weewx/wiki/WeeWX-v4-and-logging#logging-to-rotating-files).