.. _drms-introduction:
************
Introduction
************
The ``drms`` Python package can be used to access HMI, AIA and MDI data which are stored in a DRMS database system.
DRMS stands for *Data Record Management System* and is a system that was developed by the `Joint Science Operation Center `__ (JSOC), headquartered at Stanford University, to handle the data produced by the AIA and HMI instruments aboard the `Solar Dynamics Observatory `__ spacecraft.
By default the ``drms`` library uses the HTTP/JSON interface provided by JSOC and has similar functionality to the `JSOC Lookdata `__ website.
It can be used to query metadata, submit data export requests and download data files.
This module also works well for local `NetDRMS `__ sites, as long as the site runs a web server providing the needed CGI programs ``show_series`` and ``jsoc_info`` (for the data export functionality, additional CGIs, like ``jsoc_fetch``, are needed).
Installation
============
If you are using `miniforge`_ (which is conda but using the conda-forge channel):
.. code-block:: bash
conda install drms
Otherwise the ``drms`` Python package can be installed from `PyPI`_ using:
.. code-block:: bash
pip install drms
.. note::
If you do not use a Python distribution, like `miniforge`_,
and did not create an isolated Python environment using `Virtualenv`_,
you might need to add ``--user`` to the ``pip`` command:
.. code-block:: bash
pip install --user drms
.. _PyPI: https://pypi.org/project/drms/
.. _conda-forge: https://anaconda.org/conda-forge/drms
.. _miniforge: https://github.com/conda-forge/miniforge#miniforge3
.. _Virtualenv: https://virtualenv.pypa.io/en/latest/
Acknowledgements
================
Kolja Glogowski has received funding from the European Research Council under the European Union's Seventh Framework Programme (FP/2007-2013) / ERC Grant Agreement no. 307117.