Diff of /docs/index.rst [000000] .. [c52ce0]

Switch to unified view

a b/docs/index.rst
1
.. only:: not i18n
2
3
  .. note::
4
     This documentation is written to support the QuArray application, developed for Tissue Array export
5
     and analysis.
6
     Download the `latest stable binary <https://github.com/c-arthurs/QuArray/releases>`_ and an
7
     `example tissue array <https://emckclac-my.sharepoint.com/:f:/g/personal/k1472221_kcl_ac_uk/EutLIT4yc3BIlmNdUnDzLNAB0AcR1qc99Pvf8w-yCcmj_A?e=LXunb4>`_
8
     from a previously analysed cancer tissue array (Arthurs et al, *Sci Rep 2020*), or read the
9
     :ref:`installation page <installation_page>` to get started.
10
11
Welcome to the official documentation of QuArray.
12
13
QuArray Documentation
14
=====================
15
16
.. toctree::
17
   :maxdepth: 3
18
19
   Installation
20
   Input files
21
   TA export
22
   DAB stain analysis
23
   Output files
24
   Measurements
25
   Acknowledgements
26
27
Before you start
28
================
29
30
This program is optimised to to run on most up to date MacOS, Linux, and Windows operating systems.
31
32
If there are any problems getting it working then please submit a issue through GitHub.
33
34
We would love to receive any pull requests for new features and bug fixes.
35
36
Quick start guide
37
=================
38
39
#. Download the `latest stable binary <https://github.com/c-arthurs/QuArray/releases>`_.
40
#. Download `mock data <https://emckclac-my.sharepoint.com/:f:/g/personal/k1472221_kcl_ac_uk/EutLIT4yc3BIlmNdUnDzLNAB0AcR1qc99Pvf8w-yCcmj_A?e=LXunb4>`_\.
41
   Previously analysed \(Arthurs et al, Sci Rep 2020\)\.
42
#. Run the program and either:
43
44
   * :ref:`Export tissue cores<Export_page>` from a Tissue Array.
45
46
   * :ref:`Analyse DAB expression<DAB_page>` in the exported images.