==================
Download / Install
==================

.. note:: If you experience any problems installing or crashes while
          running SpinDrops, please let us know by email at
          help@spindrops.org.  Include your operating system, the
          SpinDrops version, what you were doing when the problem
          appeared, and any other information you can think of that
          will help us reproduce the problem, thanks!

SpinDrops Installers
--------------------

Stable [2.0.4]
==============

.. list-table::
   :class: no-cap-num

   * - `Android Notes`_
     - |
       | `In the Google Play Store <https://play.google.com/store/apps/details?id=org.spindrops.app>`_
   * - `iOS Notes`_
     - |
       | `In The Apple App Store <https://itunes.apple.com/us/app/spindrops/id891357240>`_
   * - `macOS Notes`_
     - |
       | `SpinDrops in the App Store <https://itunes.apple.com/us/app/spindrops/id1294137837>`_
       | (or download a :dl:`macOS Installer <SpinDrops-2.0.4.dmg>`)
     
   * - `Linux Notes`_
     - |
       | :dl:`Linux RPM Package <SpinDrops-2.0.4-1.x86_64.rpm>`
       | :dl:`Linux .deb Package <SpinDrops_2.0.4_amd64.deb>`
       | :dl:`Linux Tarball <SpinDrops-2.0.4.x86_64.tar.gz>`
   * - `in-Browser Notes`_
     - |
       | |spindrops_link|
   * - `MSWindows Notes`_
     - |
       | :dl:`Windows Installer <SpinDrops-2.0.4-install-win32.zip>`


SpinDrops version numbers attempt to adhere to so-called `Semantic
Versioning <http://semver.org/>`_.  Information about SpinDrops on
specific platforms can be found below.

The :ref:`ChangeLog` has a history of updates and bug fixes.


.. |spindrops_link| raw:: html

   No installation necessary!<br/> <a
   href="http://web.spindrops.org/2.0.4/SpinDrops.html"
   target="_blank">Click here to open SpinDrops-web in a new
   window.</a> (Firefox is recommended.  Chrome may work, slowly, and
   Safari is known to have incomplete WebGL support.  Browser
   private-mode will probably not work.)

Other Documentation
-------------------

====================================== =======================================================
File                                   Description
-------------------------------------- -------------------------------------------------------
| :dl:`SpinDrops1.2.2_Tutorial.pdf`    Tutorial for the 1.2.2 version of SpinDrops for iOS.

:dl:`PhaseCyclingTutorial_Wengert.pdf` Phase Cycling Tutorial using SpinDrops by Simon Wengert
====================================== =======================================================


Android Notes
-------------

Requires at least `IceCreamSandwich` a.k.a `Android 4.0 with GLES2.0`,
a.k.a `Android API 14`.

When first run, SpinDrops will request access to your device's
internal "SD card storage" for saving preferences and your custom
pulse sequences.

Some devices with MALI GPUs have been observed to not be able to draw
DROPS.  We're trying to fix that.

Due to the enormous variety of Android phones it is impossible for us
to test every possible handset(!)  If you experience problems, please
let us know:

- what model device you have,
- what version of the Android OS is installed on your phone, and
- a description the problem and what you were doing when it happened.

Thanks!

iOS Notes
---------

Version 1.2.2 of SpinDrops does not run on iOS 11.

macOS Notes
-----------

There are two ways to install SpinDrops on macOS, the easiest by far
is simply to install it from the Apple App store.

When installing from the ``.dmg``, there is a SpinDrops binary, the
command-line ``Ieval`` program, and a link to your Mac's Applications
folder.  To install SpinDrops, open the ``.dmg`` and drag the
SpinDrops icon into the Applications folder.  The SpinDrops
application binary is not cryptographically signed, so the first time
it is run, macOS may not allow it to run.  In order to bypass Apple's
anti-trojan protection, *Right-click the SpinDrops icon and select
Open from the menu.*

For lazy command line jockeys who just want the latest version
installed in /Applications:

.. code::
   
    curl -O http://downloads.spindrops.org/downloads/SpinDrops-2.1.0-beta24.dmg
    sudo hdiutil attach SpinDrops-2.1.0-beta24.dmg
    sudo rm -rf /Applications/SpinDrops.app
    sudo cp -R /Volumes/SpinDrops-2.1.0-beta24/SpinDrops.app /Applications
    sudo hdiutil unmount /Volumes/SpinDrops-2.1.0-beta24


Linux Notes
-----------

There is an RPM, a .deb, and a .tar.gz containing binaries built on
Ubuntu 14.04, which *should* also work on CentOS7 / RedHat 7, or any
newer Linux distribution.

When installing using the ``.rpm``, the SpinDrops binary executable
will be by default installed as ``/opt/SpinDrops/SpinDrops`` .

Copy/paste one liners for easy installation from the command line:

RedHat / CentOS / Fedora
========================

.. code::
   
    sudo rpm -ivhU http://downloads.spindrops.org/downloads/SpinDrops-2.1.0-beta24-1.x86_64.rpm
    PATH=${PATH}:/opt/SpinDrops

Debian / Ubuntu / Mint
======================

.. code::
   
    curl -sLO http://downloads.spindrops.org/downloads/SpinDrops_2.1.0-beta24_amd64.deb
    sudo dpkg -i SpinDrops_2.1.0-beta24_amd64.deb
    PATH=${PATH}:/opt/SpinDrops

From Tarball
============

.. code::
   
    curl -sLO http://downloads.spindrops.org/downloads/SpinDrops-2.1.0-beta24.x86_64.tar.gz
    sudo tar -xzv -C /opt -f SpinDrops-2.1.0-beta24.x86_64.tar.gz
    sudo mv /opt/SpinDrops-2.1.0-beta24.x86_64 /opt/SpinDrops
    PATH=${PATH}:/opt/SpinDrops


in-Browser Notes
----------------

`Your browser must support WebGL
<https://get.webgl.org/get-a-webgl-implementation/>`_.  We `strongly`
recommend using Firefox, which in our experience has the best WebGL
and WebAssembly support of any browser.  Safari is known to have
problems with WebGL, and Chrome has been observed to be noticeably
slower than Firefox.

The web version of SpinDrops saves its state (your edited sequences,
local preferences, etc...) in your web browser's local storage.
Because of this, `private browsing` mode on some browsers may prevent
SpinDrops from working.  Also, sometimes this state can become
corrupted.  To force a reset of the preferences to a known state,
simply add :code:`&--reset` to the end of the url, such as here:
|spindrops_RESET_link|.

.. |spindrops_RESET_link| raw:: html

   <a href="http://web.spindrops.org/2.0.4/SpinDrops.html?--reset"
   target="_blank">Click here to reset SpinDrops-web
   Preferences. (http://web.spindrops.org/2.0.4/SpinDrops.html?--reset)</a>

If resetting the preferences doesn't work, try clearing your browser's
cache and reloading.  SpinDrops stores its preferences and User
Sequences locally in your browser's `IndexedDB
<https://www.google.com/search?q=IndexedDB>`_, so if the RESET link
above and clearing the cache don't work, try also clearing your
browser's local "IndexedDB" (Warning: this will delete any custom
pulse sequences you had saved within the web app.)

MSWindows Notes
---------------

Older versions of Microsoft Windows may be missing dlls necessary for
running SpinDrops. The required dlls are part of the OS (since 2015),
and are also installed with updates, but may be missing from older
Windows versions.  They are available from Microsoft as a free
download, and you can find them by googling "Visual C++
Redistributable for Visual Studio 2015" :

https://www.google.com/search?q=Visual+C%2B%2B+Redistributable+for+Visual+Studio+2015

Please do contact us if you have any problems using SpinDrops on
Windows, and we'll do our best to help out!

Beta Test Versions
------------------

[2.1.0-beta24]
==============

Some test versions of SpinDrops with new functionality - these are
beta versions and likely contain bugs or other errors.

.. list-table::
   :class: no-cap-num

   * - MacOS
     - |
       | :dl:`macOS Installer beta <SpinDrops-2.1.0-beta24.dmg>`
   * - Linux
     - |
       | :dl:`Linux RPM Package <SpinDrops-2.1.0-beta24-1.x86_64.rpm>`
       | :dl:`Linux .deb Package <SpinDrops_2.1.0-beta24_amd64.deb>`
       | :dl:`Linux Tarball <SpinDrops-2.1.0-beta24.x86_64.tar.gz>`
   * - `in-Browser Notes`_
     - |
       | |spindrops_link_beta|
   * - `MSWindows Notes`_
     - |
       | :dl:`Windows Installer <SpinDrops-2.1.0-beta24-install-win32.zip>`

       
.. |spindrops_link_beta| raw:: html

   No installation necessary!<br/> <a
   href="http://web.spindrops.org/2.1.0-beta24/SpinDrops.html"
   target="_blank">Click here to open SpinDrops-web-beta in a new
   window.</a> (Firefox is recommended.  Chrome may work, slowly, and
   Safari is known to have incomplete WebGL support.  Browser
   private-mode will probably not work.)