pyValEIA.io.download
====================

.. py:module:: pyValEIA.io.download

.. autoapi-nested-parse::

   Download functions for supported data.

   ..
       !! processed by numpydoc !!


Attributes
----------

.. autoapisummary::

   pyValEIA.io.download.swarm_url


Functions
---------

.. autoapisummary::

   pyValEIA.io.download.download_and_unzip_swarm


Module Contents
---------------

.. py:data:: swarm_url
   :value: 'https://swarm-diss.eo.esa.int/?do=download&file=swarm%2FLevel'


.. py:function:: download_and_unzip_swarm(ddate, satellite, out_dir, base_url=swarm_url, level='1b', baseline='Latest_baselines', instrument='EFI', dataset='LP', f_end='0602', stime_str='000000', etime_str='235959', num_days=0, remove=False)

   
   Download daily Swarm files and unzip them into instrument-date dirs.


   :Parameters:

       **ddate: datetime object**
           Date of the desired Swarm file

       **satellite** : str
           Satellite string 'A', 'B', or 'C'

       **out_dir** : str
           String specifying base directory for file output

       **base_url** : str
           Base URL where data can be found before Level specification
           (default=`swarm_url`)

       **level** : str
           Data level, only tested on '1b' (default='1b')

       **baseline** : str
           Desired baseline, have not tested 'Entire_mission_data'
           (default='Latest_baselines')

       **instrument** : str
           Desired insturment acronym, e.g. 'EFI' is the Electric Field
           Instrument (default='EFI')

       **dataset** : str
           Desired dataset acronym from instrument, e.g. 'LP' is Langmuir Probe
           (default='LP')

       **f_end** : str
           For different data products there are different numbers at the end
           The most common for EFIxLP is '0602' where '0602' represents
           the file version. Other data products also have a record type string.
           (default='0602')

       **stime_str** : str
           Starting time using the string format "HHMMSS". Most files start with
           "000000", but if the file is not the whole day it will be different.
           Check website if download fails (default="000000")

       **etime_str** : str
           Ending time using the string format "HHMMSS". Most files end with
           "235959", but if the file is not the whole day it will be different.
           Check website if download fails (default="235959")

       **num_days** : int
           Number of days after the starting date to be downloaded after the
           initial day (default=0)

       **remove** : bool
           If True, remove zip archive after unpacking (default=False)







   :Raises:

       ValueError
           If an unknown level is supplied




   .. rubric:: Notes

   Different file options found at: https://swarm-diss.eo.esa.int/#
   File format information found at:
   https://swarmhandbook.earth.esa.int/article/product



   ..
       !! processed by numpydoc !!