.. _installation_page:

************

Installation

************

Getting Started

###############

QuArray is a stand-alone, platform independent application (designed for Windows, Mac or Linux operating systems),

and requires only a correct binary file to be downloaded. The binary is available from

`GitHub <https://github.com/c-arthurs/QuArray>`_.

  .. note::

     An example Tissue Array is hosted

     `here <https://emckclac-my.sharepoint.com/:f:/g/personal/k1472221_kcl_ac_uk/EutLIT4yc3BIlmNdUnDzLNAB0AcR1qc99Pvf8w-yCcmj_A?e=LXunb4>`_.

     The file contains a previously analysed cancer tissue array (Arthurs et al, *Sci Rep 2020*) and mock data file.

The application may take a short while to start when newly installed (as it is compiled with PyQt5 as a single executable file) however,

this is not a problem once the GUI is initialised. The start up times vary between operating systems due to differences in how the OS checks the files. A benchmark for each OS is as follows - Ubuntu 20.04LTS 3seconds, Windows 10 42seconds, MacOS Catalina 57seconds.

Operating systems

#################

MacOS

-----

The binaries may be compatible on earlier operating systems but it has been tested on MacOS Catalina 10.15.6 and newer.

To get started, download the latest stable version of the

:download:`MacOS binary <https://github.com/c-arthurs/QuArray/releases/download/v0.6/QuArray_macos.app.zip>`

here or by using the link at the top of this page.

The downloaded application can be moved into your applications folder or run from the downloads folder if necessary.

On the first opening of the file the user may have to certify that the program is from an unknown developer.

The application should then boot as shown in the instructional videos.

Windows

-------

The binaries should be compatible with Windows7 and newer.

To get started, download the latest stable version of the

:download:`Windows binary <https://github.com/c-arthurs/QuArray/releases/download/v0.6/QuArray_windows.exe>`

here of by using the link at the top of this page.

The downloaded application can be moved to any location on the computer.

The application should then boot as shown in the instructional videos.

Linux

-----

The binaries may be compatible on other distros but it has been tested on Ubuntu 16.04 LTS.

It should be compatible with all versions of Ubuntu newer than this.

Download the :download:`Ubuntu binary <https://github.com/c-arthurs/QuArray/releases/download/v0.6/QuArray_ubuntu>`

and make sure to make it executable by running -

.. code-block:: bash

   sudo chmod +x QuArray_ubuntu

Or you can do this in the Ubuntu desktop.

The program should then start as shown in the instructional videos.