.. raw:: html

    <div style="text-align: center;">

###############
Getting Started
###############

|

Installation
============
The package can be installed through pip:

.. code-block:: console

    $ pip install AstroToolkit

|

Important Information
=====================
ATK uses `Bokeh <https://bokeh.org/>`_ as its plotting library. This allows for all plots to be saved as static HTML files that retain their interactive elements. An example of a plot generated by the ATK is shown below - try hovering over and clicking on the centres of the detection markers!

.. raw:: html
    
    <div align="center">

.. bokeh-plot:: tutorials/_intro_image.py
    :source-position: none

.. raw:: html

    </div>

|

Elements in all ATK plots (such as the Gaia/GALEX detections in the above image) can be toggled by clicking on them in the legend, and the legend itself can be hidden by double-clicking anywhere else in the figure. 

|

Proper Motion Correction
------------------------
Another key feature of ATK is proper motion correction. There will be more on this in later tutorials, but many examples of this can already be seen in the image above. `Van Maanen's Star <https://simbad.u-strasbg.fr/simbad/sim-id?Ident=van+Maanen%27s+Star&NbIdent=1&Radius=2&Radius.unit=arcmin&submit=submit+id>`_ is the closest known solitary white dwarf to our solar system, and hence has an extremely high proper motion of approximately 3 arcsec/yr. 

|

**The above image displays proper motion correction in the following ways:**

The image, which was taken on a photographic plate in 1953 and subsequently digitised in the Digitized Sky Survey (DSS), has been centred on `van Maanen's Star <https://simbad.u-strasbg.fr/simbad/sim-id?Ident=van+Maanen%27s+Star&NbIdent=1&Radius=2&Radius.unit=arcmin&submit=submit+id>`_ despite the 63 year difference between the epoch of the image and the epoch of Gaia's astrometry (resulting in a displacement of over 3 arc minutes!).

Gaia's detection markers have been corrected for this displacement, correctly aligning them with their host systems. GALEX detection markers have also been corrected where possible, despite the survey not providing its own proper motion measurements.

Proper motion correction has been used to match the host object in SIMBAD.


|
 
Tutorials
=========
A full set of tutorials can be found starting with the :doc:`next section <../auto_tutorials/getting_started/data_query>`. These are designed to be followed sequentially, and so some tutorials may utilise information from previous sections (this will typically be pointed out with a link to the necessary information).

|

.. toctree::
    :maxdepth: 2
    :hidden:
    :caption: Getting Started
    
    tutorials/getting_started/custom_index
    tutorials/images/custom_index
    tutorials/lightcurves/custom_index
    tutorials/spectra/custom_index
    tutorials/seds/custom_index
    tutorials/hrds/custom_index

|

Technical Details
=================
Detailed technical documentation can be found :doc:`here <modules>`.

|
|
|

.. raw:: html

    </div>