| 1 |
.. _drms-introduction: |
| 2 |
|
| 3 |
************ |
| 4 |
Introduction |
| 5 |
************ |
| 6 |
|
| 7 |
The ``drms`` Python package can be used to access HMI, AIA and MDI data which are stored in a DRMS database system. |
| 8 |
|
| 9 |
DRMS stands for *Data Record Management System* and is a system that was developed by the `Joint Science Operation Center <http://jsoc.stanford.edu/>`__ (JSOC), headquartered at Stanford University, to handle the data produced by the AIA and HMI instruments aboard the `Solar Dynamics Observatory <https://sdo.gsfc.nasa.gov//>`__ spacecraft. |
| 10 |
|
| 11 |
By default the ``drms`` library uses the HTTP/JSON interface provided by JSOC and has similar functionality to the `JSOC Lookdata <http://jsoc.stanford.edu/ajax/lookdata.html>`__ website. |
| 12 |
It can be used to query metadata, submit data export requests and download data files. |
| 13 |
|
| 14 |
This module also works well for local `NetDRMS <http://jsoc.stanford.edu/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). |
| 15 |
|
| 16 |
Installation |
| 17 |
============ |
| 18 |
|
| 19 |
If you are using `miniforge`_ (which is conda but using the conda-forge channel): |
| 20 |
|
| 21 |
.. code-block:: bash |
| 22 |
|
| 23 |
conda install drms |
| 24 |
|
| 25 |
Otherwise the ``drms`` Python package can be installed from `PyPI`_ using: |
| 26 |
|
| 27 |
.. code-block:: bash |
| 28 |
|
| 29 |
pip install drms |
| 30 |
|
| 31 |
.. note:: |
| 32 |
If you do not use a Python distribution, like `miniforge`_, |
| 33 |
and did not create an isolated Python environment using `Virtualenv`_, |
| 34 |
you might need to add ``--user`` to the ``pip`` command: |
| 35 |
|
| 36 |
.. code-block:: bash |
| 37 |
|
| 38 |
pip install --user drms |
| 39 |
|
| 40 |
.. _PyPI: https://pypi.org/project/drms/ |
| 41 |
.. _conda-forge: https://anaconda.org/conda-forge/drms |
| 42 |
.. _miniforge: https://github.com/conda-forge/miniforge#miniforge3 |
| 43 |
.. _Virtualenv: https://virtualenv.pypa.io/en/latest/ |
| 44 |
|
| 45 |
Acknowledgements |
| 46 |
================ |
| 47 |
|
| 48 |
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. |