.. Marvin documentation master file, created by
   sphinx-quickstart on Sun Apr 10 08:50:42 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. title:: Marvin documentation


.. image:: _static/logo5_lores.jpg
    :width: 600px
    :align: center
    :alt: MaNGA logo

|

Marvin Documentation
====================

Marvin is a tool specifically designed to visualise and analyse `MaNGA <https://www.sdss.org/surveys/manga/>`_ data. It is developed and maintained by the MaNGA team. Marvin allows you to:

* Access reduced MaNGA datacubes local, remotely, or via a `web interface <https://dr16.sdss.org/marvin>`_.
* Access and visualise data analysis products.
* Perform powerful queries on data and metadata.
* Abstract the datamodel and forget where the data actually lives.
* Make good visualisation and scientific decisions by preventing common mistakes when accessing the data.

.. To install marvin simply run ``pip install sdss-marvin``. More details and known problem with installation can be found :ref:`here <marvin-installation>`.

.. note:: This documentation assumes that you are familiar with MaNGA data and its acronyms. If that is not your case, consider reading `this <https://www.sdss.org/dr16/manga/getting-started/>`_.

.. warning:: As of June 2024, the Marvin Web and API have been migrated to a new server home.
   ``sdss-marvin >= 2.8.2`` has been updated to reflect this change.  Please update to the latest package version.
   For package versions ``<= 2.8.1``, please see this :ref:`Workaround <marvin-server-workaround>`


At a Glance
-----------

If you are new to Marvin check the following links before diving into the full documentation:

* New to MaNGA?  Read the intro on the `SDSS MaNGA survey <https://www.sdss.org/surveys/manga/>`_.
* :doc:`installation`
* :doc:`What's new in Marvin? <whats-new>`
* The :doc:`Getting Started <getting-started>` is your quick start guide to Marvin.
* For quick reference, check out the :doc:`cheatsheet`.
* For more detailed examples, see the :doc:`tutorials/index`.
* Here is an :ref:`introduction <marvin-quantities>` to the `Astropy quantity <http://docs.astropy.org/en/stable/units/quantity.html>`_ class that Marvin uses to represent data (spectra, data cubes, etc).
* We welcome :doc:`contributions <contributing/contributing>` to Marvin!
* If you use Marvin in any way, please :doc:`cite and acknowledge Marvin <citation>`.


.. toctree::
   :maxdepth: 2
   :caption: At a Glance
   :hidden:

   installation
   whats-new
   getting-started
   cheatsheet
   tutorials/index
   contributing/contributing
   citation

.. toctree::
   :maxdepth: 2
   :caption: User Docs

   getting-started
   tools/index
   query/index
   web
   api


.. toctree::
   :maxdepth: 3
   :caption: Datamodels

   datamodel/datamodels

.. toctree::
   :maxdepth: 2
   :caption: API/Code Reference

   reference/index

.. toctree::
   :maxdepth: 1
   :caption: Project Details

   Changelog <changelog>
   Known Issues <known-issues>
   faq


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`

* :ref:`search`