Files
weewx/docs/macos.htm
2018-04-14 09:21:03 -04:00

140 lines
5.6 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>weewx: Installation on macOS systems</title>
<meta http-equiv="Content-Language" content="en-us"/>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<link rel="stylesheet" href="css/weewx_docs.css"/>
<link rel="icon" href="images/favicon.png" type="image/png"/>
</head>
<body>
<h1 class="title">weeWX: Installation on macOS systems
<span class='os-icons'>
<img class='logo' src='images/logo-apple.png' alt=""/>
</span>
</h1>
<p>This is a guide to installing weeWX on macOS.</p>
<h2>Download</h2>
<p>
Download the source archive <span class='code'>weewx-X.Y.Z.tar.gz</span> from <a href="http://weewx.com/downloads"><span class="code">weewx.com/downloads</span></a>.
</p>
<h2>Install prerequisites</h2>
<p>Ensure that Python2 is installed. Python 2.6 or 2.7 will work,
but Python 3 will not.</p>
<pre class='tty cmd'>python -V</pre>
<p>Make sure that <a href="https://pypi.python.org/pypi/pip">pip</a> has been installed on
your system. If not, it may be as simple as:</p>
<pre class='tty cmd'>sudo easy_install pip</pre>
<p>Now install the required Python packages using pip.</p>
<pre class='tty cmd'>sudo pip install pysqlite
sudo pip install configobj
sudo pip install Cheetah
sudo pip install PIL
sudo pip install pyserial
sudo pip install pyusb
sudo pip install pyephem</pre>
<p>Depending on the macOS and Python versions, you might have to use <span class="code">Pillow</span> instead of <span class="code">PIL</span>.</p>
<p>If the PIL or Cheetah installation fails, you might have to install xcode:</p>
<pre class='tty cmd'>xcode-select --install</pre>
<p>then try the pip install again.</p>
<h2>Install weeWX</h2>
<p>Expand the source archive:</p>
<pre class="tty cmd">tar xvfz weewx-X.Y.Z.tar.gz</pre>
<p>Change directory:</p>
<pre class="tty cmd">cd weewx-X.Y.Z</pre>
<p>Modify <span class="code">home</span> in <span class="code">setup.cfg</span> to set the installation location to <span class="code">/Users/Shared/weewx</span></p>
<pre class="tty cmd">perl -pi -e 's%^home.*%home = /Users/Shared/weewx%' setup.cfg</pre>
<p>Install:</p>
<pre class="tty cmd">python setup.py install</pre>
<p>
The installer will prompt for a location, latitude/longitude, altitude, station type, and parameters specific to the station.
</p>
<h2>Run</h2>
<p>Run the main program directly:</p>
<pre class="tty cmd">cd /Users/Shared/weewx
./bin/weewxd weewx.conf</pre>
<p>Or as a daemon automatically when the computer starts:</p>
<pre class="tty cmd">sudo cp /Users/Shared/weewx/util/launchd/com.weewx.weewxd.plist /Library/LaunchDaemons
sudo launchctl load /Library/LaunchDaemons/com.weewx.weewxd.plist</pre>
<h2>Status</h2>
<p>To make sure things are running properly, look in the system log for messages from weeWX. Run the <span class="code">Console</span> application and select <span class="code">All Messages</span>.
</p>
<h2>Verify</h2>
<p>After about 5 minutes, open the station web page in a web browser. You should see your station information and data.
If your hardware supports hardware archiving, then how long you wait will depend on the <a href="usersguide.htm#archive_interval">archive interval</a> set in your hardware.
</p>
<pre class='tty'><a href="file:///Users/Shared/weewx/public_html/index.html">file:///Users/Shared/weewx/public_html/index.html</a></pre>
<h2>Customize</h2>
<p>To enable uploads such as Weather Underground or to customize reports, modify the configuration file <span class='code'>/Users/Shared/weewx/weewx.conf</span>. See the <a href="usersguide.htm">User Guide</a> and <a href="customizing.htm">Customization Guide</a> for details.
</p>
<p>WeeWX must be restarted for configuration file changes to take effect.
</p>
<h2>Start/Stop</h2>
<p>To start/stop weeWX:</p>
<pre class='tty cmd'>sudo launchctl load /Library/LaunchDaemons/com.weewx.weewxd.plist
sudo launchctl unload /Library/LaunchDaemons/com.weewx.weewxd.plist</pre>
<h2>Uninstall</h2>
<p>To uninstall, simply delete the directory <span class='code'>/Users/Shared/weewx</span>. This will delete weeWX, configuration files, and data.</p>
<pre class='tty cmd'>rm -r /Users/Shared/weewx
sudo rm /Library/LaunchDaemons/com.weewx.weewxd.plist</pre>
<h2>Layout</h2>
<p>The instructions above will result in the following layout:</p>
<table class='locations' style="width: auto;">
<tr>
<td align='right'>executable:</td>
<td class='tty'>/Users/Shared/weewx/bin/weewxd</td>
</tr>
<tr>
<td align='right'>configuration file:</td>
<td class='tty'>/Users/Shared/weewx/weewx.conf</td>
</tr>
<tr>
<td align='right'>skins and templates:</td>
<td class='tty'>/Users/Shared/weewx/skins/</td>
</tr>
<tr>
<td align='right'>sqlite databases:</td>
<td class='tty'>/Users/Shared/weewx/archive/</td>
</tr>
<tr>
<td align='right'>generated web pages and images:</td>
<td class='tty'>/Users/Shared/weewx/public_html/</td>
</tr>
<tr>
<td align='right'>documentation:</td>
<td class='tty'>/Users/Shared/weewx/docs/</td>
</tr>
<tr>
<td align='right'>examples:</td>
<td class='tty'>/Users/Shared/weewx/examples/</td>
</tr>
<tr>
<td align='right'>utilities:</td>
<td class='tty'>/Users/Shared/weewx/bin/wee_*</td>
</tr>
</table>
<p class='copyright'>
&copy; <a href='copyright.htm'>Copyright</a> Tom Keffer
</p>
</body>
</html>