.. _getting started:

==============================
Setting Up and Getting Started
==============================


Installing Mantid
=================

Mantid is available to download for Windows, Linux or Mac. Our releases are available to download from the
`Downloads section <https://download.mantidproject.org/>`_ of the website.

On the downloads page you will be able to get the current stable release of Mantid, which is recommended.
There is also an option to download the latest nightly build, this is a more experimental version of the software.
Whilst the nightly build may have more features, it is less tested and is likely to be less stable than the release.

You will also find detailed instructions for installing Mantid on different operating systems.

.. figure:: /images/MantidDownload.png
   :width: 500px
   :alt: Download page
   :target: https://download.mantidproject.org/
   :align: center

.. If / when First-Time Setup is added into Workbench,
   then feel free to add a section back in here about it
   (See previous Git history).

Getting Training Course Data
============================

All of the data you need to follow this course can be downloaded
from the bottom-left corner of the `downloads page <http://download.mantidproject.org/>`_.

* Download the file "TrainingCourseData.zip"
* Unzip this file in a location of your choice (ie. Desktop).

Manage User Directories
=======================

.. figure:: /images/ManageUserDirectories.PNG
   :width: 400px
   :alt: Manage User Directories
   :align: center

* Open Mantid Workbench
* Select "File" > "Manage User Directories"
* Click "Browse To Directory" and navigate to the location of your data files
* Do the same for the default save directory
* Click "OK"

Error Reporter
==============

You may find a bug at some stage using Mantid, and here is how to tell us about it! Please, send in your name and email otherwise we are unlikely
to resolve the problem. Please give as much information as possible.

.. figure:: /images/ErrorReporterTutorial.PNG
   :alt: Error Reporter
   :align: center