Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Developer guide for further development. #147

Merged
merged 16 commits into from
Jan 20, 2025
Merged
12 changes: 12 additions & 0 deletions docs/dev_guide/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _sunpy-soar-dev-guide-index:
nabobalis marked this conversation as resolved.
Show resolved Hide resolved

***************
Developer Guide
***************

This guide will walk you through about contributing towards sunpy-soar.
NucleonGodX marked this conversation as resolved.
Show resolved Hide resolved

.. toctree::
:maxdepth: 1

working
36 changes: 36 additions & 0 deletions docs/dev_guide/working.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
.. _sunpy-soar-dev-guide-working:

*****************************
How does ``sunpy-soar`` work?
*****************************

``sunpy-soar`` is a Python library developed to interact with the SOAR (Solar Orbiter Archive) data
hosted by ESA (European Space Agency). It provides tools and utilities to access, search, download and
analyze data collected by the Solar Orbiter mission.

How data is retrieved from SOAR
==============================

To retrieve data from SOAR, you first use the ``Fido`` object from SunPy
and specify the desired attributes using `sunpy.net.attrs`. These
attributes define the criteria for the data you want to retrieve, such as the
time range, instrument, or wavelength. Here is an example of how to specify
the time range for the data you want to retrieve:
NucleonGodX marked this conversation as resolved.
Show resolved Hide resolved

.. code-block:: python

import sunpy.net.attrs as a
from sunpy.net import Fido
import sunpy_soar

instrument = a.Instrument("EUI")
time = a.Time("2021-02-01", "2021-02-02")
level = a.Level(1)
product = a.soar.Product("EUI-FSI174-IMAGE")

result = Fido.search(instrument & time & level & product)


``sunpy-soar`` constructs the query based on the specified criteria, then generates a URL to interact with the SOAR API.
This is done by using the Table Access Protocol (TAP), a widely adopted standard in the astronomical community for accessing large datasets.
nabobalis marked this conversation as resolved.
Show resolved Hide resolved
The results are returned in the form of an Astropy table, providing a structured and efficient format for further analysis and visualization within the Python environment.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ This will walk you through getting set up for contributing.
:hidden:

generated/gallery/index
dev_guide/index
how_to/index
api
changelog
NucleonGodX marked this conversation as resolved.
Show resolved Hide resolved
Expand Down
Loading