TweetyPy

Check-in [d33935bbfe]

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Added OSs to TOC
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: d33935bbfe0da17c63319c7dc2ac34586703452be0947a60d869120ef46a0036
User & Date: jmcclure 2017-09-11 21:52:10
Context
2017-09-13
00:51
Usage documentation check-in: 23934f44e6 user: jmcclure tags: trunk
2017-09-11
21:52
Added OSs to TOC check-in: d33935bbfe user: jmcclure tags: trunk
21:49
Added pip option to Linux installation check-in: 8460427c7d user: jmcclure tags: trunk
Changes

Changes to info.html.

46
47
48
49
50
51
52





53
54
55
56
57
58
59
..
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
...
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

<section id="toc">
<h2>Table Of Contents</h2>
<ol type="I" style="margin-left: 1em; line-height: 1.5em;">
<a href="#"><li>General Introduction</li></a>
<a href="#toc"><li>Table Of Contents</li></a>
<a href="#install"><li>Installation</li></a>





<a href="#config1"><li>Basic Configuration</li></a>
<a href="#usage"><li>Step-By-Step Usage</li></a>
	<ol type="i" style="margin-left: -0.5em;">
	<a href="#usage-fex"><li>Frequency Excursion</li></a>
	</ol>
<a href="#config2"><li>Advanced Configuration</li></a>
	<ol type="i" style="margin-left: -0.5em;">
................................................................................
source files:</p>
<pre><code>python setup.py install</code></pre>
<p>In either case <code>setuptools</code> should install the remaining
depdendencies numpy<a class="note-link" href="#install-note-5">5</a>,
scipy<a class="note-link" href="#install-note-6">6</a>, and
PyYAML<a class="note-link" href="#install-note-7">7</a>.  If not, these may need
to be installed separately.</p>
<h3>Mac OSX</h3>
<p>Mac OSX typically comes with python preinstalled, however it is an older
version of python.  You will need to install python 3.6 or later<a
class="note-link" href="#install-note-1">1</a>.  The installer will install
python3 along-side any existing python2 installation, however the default python
and pip commands will still use the python2 versions so you will need to use the
-3 suffix for pip.  Once python 3.6 is installed, the following command in a
terminal should suffice to complete the installation of tweetypy:</p>
<pre><code>pip3 install tweetypy</code></pre>
<p>This should install all the dependencies followed by tweetypy itself.
Preliminary testing on a mac resulted in a successful installation and minimal
test of a working tweetypy install.</p>
<h3>Windows</h3>
<p>Installing the dependencies of NumPy and SciPy on Windows is a bit tricker.
As one of the NumPy team says &ldquo;If you're on Windows, and you try the same
thing with pip, all hell will break loose.&rdquo;<a class="note-link"
href="#install-note-8">8</a>.  This may be fixed in recent versions of NumPy,
but SciPy is still an issue<a class="note-link" href="#install-note-9">9</a>.
Precompiled "wheels" built against the Intel math kernel library are, however,
available.</p>
................................................................................
install tweetypy from PyPi:
<pre><code>pip install tweetypy</code></pre>
This should find the existing installation of NumPy and SciPy and only install
the remaining needed dependencies followed by tweetypy.</li>
</ol>
<p>Preliminary testing on Windows 10 resulted in a successful installation and
minimal test of a working tweetypy install.</p>
<h3>Linux</h3>
<p>A <code>PKGBUILD</code> is provided in the source repository for ArchLinux.
Other distros may use <code>python setup.py install</code> from the root of
the source repository.  If you are able to help package TweetyPy for your
distro, please feel free to open a feature request on the ticket tracker.
Alternatively, tweetypy can be installed directly from PyPi via pip.</p>
<ol class="notes">
<li id="install-note-1">Install Python 3.6 or higher via your package / software







>
>
>
>
>







 







|











|







 







|







46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
..
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
...
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

<section id="toc">
<h2>Table Of Contents</h2>
<ol type="I" style="margin-left: 1em; line-height: 1.5em;">
<a href="#"><li>General Introduction</li></a>
<a href="#toc"><li>Table Of Contents</li></a>
<a href="#install"><li>Installation</li></a>
	<ol type="i" style="margin-left: -0.5em;">
	<a href="#install-mac"><li>Mac OSX</li></a>
	<a href="#install-win"><li>Windows</li></a>
	<a href="#install-linux"><li>Linux</li></a>
	</ol>
<a href="#config1"><li>Basic Configuration</li></a>
<a href="#usage"><li>Step-By-Step Usage</li></a>
	<ol type="i" style="margin-left: -0.5em;">
	<a href="#usage-fex"><li>Frequency Excursion</li></a>
	</ol>
<a href="#config2"><li>Advanced Configuration</li></a>
	<ol type="i" style="margin-left: -0.5em;">
................................................................................
source files:</p>
<pre><code>python setup.py install</code></pre>
<p>In either case <code>setuptools</code> should install the remaining
depdendencies numpy<a class="note-link" href="#install-note-5">5</a>,
scipy<a class="note-link" href="#install-note-6">6</a>, and
PyYAML<a class="note-link" href="#install-note-7">7</a>.  If not, these may need
to be installed separately.</p>
<h3 id="install-mac">Mac OSX</h3>
<p>Mac OSX typically comes with python preinstalled, however it is an older
version of python.  You will need to install python 3.6 or later<a
class="note-link" href="#install-note-1">1</a>.  The installer will install
python3 along-side any existing python2 installation, however the default python
and pip commands will still use the python2 versions so you will need to use the
-3 suffix for pip.  Once python 3.6 is installed, the following command in a
terminal should suffice to complete the installation of tweetypy:</p>
<pre><code>pip3 install tweetypy</code></pre>
<p>This should install all the dependencies followed by tweetypy itself.
Preliminary testing on a mac resulted in a successful installation and minimal
test of a working tweetypy install.</p>
<h3 id="install-win">Windows</h3>
<p>Installing the dependencies of NumPy and SciPy on Windows is a bit tricker.
As one of the NumPy team says &ldquo;If you're on Windows, and you try the same
thing with pip, all hell will break loose.&rdquo;<a class="note-link"
href="#install-note-8">8</a>.  This may be fixed in recent versions of NumPy,
but SciPy is still an issue<a class="note-link" href="#install-note-9">9</a>.
Precompiled "wheels" built against the Intel math kernel library are, however,
available.</p>
................................................................................
install tweetypy from PyPi:
<pre><code>pip install tweetypy</code></pre>
This should find the existing installation of NumPy and SciPy and only install
the remaining needed dependencies followed by tweetypy.</li>
</ol>
<p>Preliminary testing on Windows 10 resulted in a successful installation and
minimal test of a working tweetypy install.</p>
<h3 id="install-linux">Linux</h3>
<p>A <code>PKGBUILD</code> is provided in the source repository for ArchLinux.
Other distros may use <code>python setup.py install</code> from the root of
the source repository.  If you are able to help package TweetyPy for your
distro, please feel free to open a feature request on the ticket tracker.
Alternatively, tweetypy can be installed directly from PyPi via pip.</p>
<ol class="notes">
<li id="install-note-1">Install Python 3.6 or higher via your package / software