<p>TweetyPy will run on any system capable of running Python 3.6<a class="note-link"
href="#install-note-1">1</a> and Qt5<a class="note-link"
href="#install-note-2">2</a>.  TweetyPy is available from the PyPi &ldquo;Cheese
Shop&rdquo;<a class="note-link" href="#install-note=3">3</a> which will be
updated with each minor-version release.  These releases &mdash; as well as the most
recent development code &mdash; can also be obtained directly from the
Fossil VCS source<a class="note-link" href="#install-note=4">4</a>.  Once Python
3.6 is installed on your system, TweetyPy can be installed directly
from PyPi via pip:</p>
<pre><code>pip install tweetypy</code></pre>
<p>Alternatively, TweetyPy can be installed from sources retrieved from PyPi or
Fossil with the following command from within the top-level directory of the
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>
<ol>
<li>Install python 3.6 or newer from the python website.
<li>Download a suitable version of NumPy and SciPy from Christoph Gohlke's page
at the University of California<a class="note-link"
href="#install-note-10">10</a>.  I used the cp36-cp36m-win32 builds for my test
on Windows 10.</li>
<li>Install each of the downloaded wheel files NumPy first, then SciPy.  From a
console / dos prompt:
<pre><code>cd \path\to\Downloads
pip install numpy-1.13.1+mkl-cp36-cp36m-win32.whl
pip install scipy-0.19.1-cp36-cp36m-win32.whl</code></pre></li>
<li>If the above dependencies installed successfully you should not be able to
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.</p>
<ol class="notes">
<li id="install-note-1">Install Python 3.6 or higher via your package / software
manager or from the <a href="https://www.python.org/">Python website</a>.</li>
<li id="install-note-2">Install Qt5 via your package / software
manager or from the <a href="http://doc.qt.io/qt-5/supported-platforms.html">Qt5 Website</a>.</li>
<li id="install-note-3">TweetyPy on PyPi (<a href="https://pypi.python.org/pypi/tweetypy">link</a>)</li>
<li id="install-note-4">Fossil VCS repository (<a href="https://repo.jessemcclure.org/tweetypy/timeline">link</a>)</li>
<li id="install-note-5"><a href="http://www.numpy.org/">Numpy</a></li>
<li id="install-note-6"><a href="https://www.scipy.org/">SciPy</a></li>
<li id="install-note-7"><a href="http://pyyaml.org/">PyYAML</a></li>
<li id="install-note-8"><a href="https://github.com/numpy/numpy/wiki/Whats-with-Windows-builds">What's With Window's Builds</a></li>
<li id="install-note-9"><a href="https://github.com/scipy/scipy/issues/5461">Issue 5461</a></li>
<li id="install-note-10"><a href="www.lfd.uci.edu/~gohlke/pythonlibs/#numpy">NumPy wheels</a>, <a href="www.lfd.uci.edu/~gohlke/pythonlibs/#scipy">SciPy wheels</a></li>
</ol>
</section>

<section id="config1">
<h2>Basic Configuration</h2>
<p>Configuration files are provided with reasonable defaults that should work
&lsquo;out-of-the-box&rsquo; for many analyses.  Configuration files are written

frequency excursion should be feature-complete.  Any remaining version 1.X
releases will be for bug fixes or for code-refactoring in preparation of the
additional features to come with the 2.X releases.</p>

<h3>Version 1.0 release (Ain't She Tweet)</h3>
<ol type="i">
<li>complete documentation</li>

</ol>
<h3>Version 1.1 release (All a Bir-r-r-rd)</h3>
<ol type="i">
<li>app icon</li>
<li>adjustable eraser size</li>
<li>toolbar position configuration</li>
<li>add save button and remember filename (use as default for next save)</li>

</ol>
<h3>Version 1.2 release (Bad Ol' Putty Tat)</h3>
<ol type="i">
<li>possible eraser shapes/rotations</li>
<li>drag and drop adding of files</li>
<li>'back' navigation (and save/commit options for repeats)</li>
<li>trim with cursor</li>

from setuptools import setup

def readme():
	with open('README.rst') as f:
		return f.read()

setup(
	name='tweetypy',
	version='1.0.0rc6',
	description='Bird song analysis tools',
	long_description=readme(),
	classifiers=[
		'Development Status :: 3 - Alpha',
		'License :: OSI Approved :: MIT License',
		'Intended Audience :: Science/Research',
		'Programming Language :: Python :: 3',
		'Topic :: Multimedia :: Sound/Audio :: Analysis',
		'Topic :: Scientific/Engineering :: Visualization'
	],
	url='http://jessemcclure.org',
	author='Jesse McClure',
	author_email='jmcclure@broadinstitute.org',
	license='MIT',
	packages=['tweetypy'],
	package_data={'tweetypy': ['*.yaml']},
	install_requires=['numpy', 'scipy', 'pyYAML', 'PyQt5' ],
	python_requires='>=3',
	entry_points={'console_scripts': ['tweetypy=tweetypy:main']},
	include_package_data=True,
	zip_safe=False)