.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_tutorials/configuration/config.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_auto_tutorials_configuration_config.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_auto_tutorials_configuration_config.py:


##########
The Config
##########
ATK uses a config file to manage many default behaviours. **For a list and description of all available config keys, see the** :doc:`next tutorial <config_keys>`.

Opening the Config
==================
The config can be opened in the default text editor, either from the commandline:

.. code-block:: console

    $ ATKconfig open

or from inside a script:

.. code-block:: python

    from ATK.Config import CONFIG

    CONFIG.open()

|

Viewing the Config
==================
To print the config to the terminal, use:

.. code-block:: console

    $ ATKconfig show

or:

.. GENERATED FROM PYTHON SOURCE LINES 35-41

.. code-block:: Python


    from ATK.Config import CONFIG

    CONFIG.show()






.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    [global_settings]
    unit_format = symbol

    [plot_settings]
    cache_time = 3600
    size = 500
    backend = canvas
    toolbars = True
    grids = True
    titles = False
    font = Helvetica
    font_size = 14

    [query_settings]
    query_radius = 3
    image_size = 30
    default_scale = arcsec

    [overlay_settings]
    crossmatch_radius = 5
    simbad_radius = 3

    [datapage_settings]
    grid_size = 150
    font = Helvetica
    font_size = 6





.. GENERATED FROM PYTHON SOURCE LINES 55-86

|

Editing the config
==================
The value of a key in a given section of the config can be set as follows:

.. code-block:: console

   $ ATKconfig set <section> <key> <value>

.. code-block:: python

   from ATK.Config import CONFIG

   CONFIG[section][key] = [value]

|

Resetting the Config
====================
The config can also be reset to its default state:

.. code-block:: console

   $ ATKconfig reset

.. code-block:: python

   from ATK.Config import CONFIG

   CONFIG.reset()

.. GENERATED FROM PYTHON SOURCE LINES 89-94

|
|
|

.. rubric:: Download this Tutorial


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 0.004 seconds)


.. _sphx_glr_download_auto_tutorials_configuration_config.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: config.ipynb <config.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: config.py <config.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: config.zip <config.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_