#!/usr/bin/env python
# coding: utf-8

# # Imports

# In[1]:


import pyaurorax
import os
import pprint
import pandas as pd


# # Get all data sources

# In[2]:


# get data sources
sources = pyaurorax.sources.list(order="program")

# show as a pandas dataframe
sources_dict = [source.__dict__ for source in sources]
df = pd.DataFrame(sources_dict, 
                  columns=[
                      "identifier", 
                      "program", 
                      "platform", 
                      "instrument_type", 
                      "source_type", 
                      "display_name"
                  ])
df.sort_values(["program", "platform"])


# # Get all THEMIS ASI data sources

# In[3]:


# get data sources
sources = pyaurorax.sources.list(program="themis-asi")

# show as a pandas dataframe
sources_dict = [source.__dict__ for source in sources]
df = pd.DataFrame(sources_dict, 
                  columns=[
                      "identifier", 
                      "program", 
                      "platform", 
                      "instrument_type", 
                      "source_type", 
                      "display_name"
                  ])
df.sort_values(["program", "platform"])


# # Get all RGB instrument types

# In[4]:


# get data sources
sources = pyaurorax.sources.list(instrument_type="RGB ASI")

# show as a pandas dataframe
sources_dict = [source.__dict__ for source in sources]
df = pd.DataFrame(sources_dict, 
                  columns=[
                      "identifier", 
                      "program", 
                      "platform", 
                      "instrument_type", 
                      "source_type", 
                      "display_name"
                  ])
df.sort_values(["program", "platform"])


# # Get all Swarm data sources

# In[5]:


# get data sources
sources = pyaurorax.sources.list(program="swarm")

# show as a pandas dataframe
sources_dict = [source.__dict__ for source in sources]
df = pd.DataFrame(sources_dict, 
                  columns=[
                      "identifier", 
                      "program", 
                      "platform", 
                      "instrument_type", 
                      "source_type", 
                      "display_name"
                  ])
df.sort_values(["program", "platform", "instrument_type"])


# # Get all low-earth orbit data sources (LEO)

# In[6]:


# source type options are "leo", "heo", "ground", "lunar", or "event_list"
sources = pyaurorax.sources.list(source_type=pyaurorax.SOURCE_TYPE_LEO)

# show as a pandas dataframe
sources_dict = [source.__dict__ for source in sources]
df = pd.DataFrame(sources_dict, 
                  columns=[
                      "identifier", 
                      "program", 
                      "platform", 
                      "instrument_type", 
                      "source_type", 
                      "display_name"
                  ])
df.sort_values(["program", "platform"])


# # Determine the identifier for a data source

# In[7]:


data_sources = pyaurorax.sources.list(program="swarm",
                                      platform="swarma",
                                      instrument_type="footprint")
identifier = data_sources[0].identifier
print("Identifier: %d" % (identifier))


# # Get data source using identifier

# In[8]:


# get data source
data_source = pyaurorax.sources.get_using_identifier(3)
pprint.pprint(data_source)


# # Get data source information with different levels of information
# 
# You can retrieve different amounts of information about data sources. The default is `pyaurorax.FORMAT_BASIC_INFO` which provides some basic information, there are also format types for smaller or larger amounts of information.

# In[9]:


# as little information as possible
data_sources = pyaurorax.sources.list(program="swarm",
                                      platform="swarma",
                                      instrument_type="footprint",
                                      format=pyaurorax.FORMAT_IDENTIFIER_ONLY)
print(data_sources[0])


# In[11]:


# default information
data_source = pyaurorax.sources.get_using_identifier(3, format=pyaurorax.FORMAT_BASIC_INFO)
print(data_source)


# In[12]:


# basic info, but with metadata
data_source = pyaurorax.sources.get_using_identifier(3, format=pyaurorax.FORMAT_BASIC_INFO_WITH_METADATA)
print(data_source)


# In[13]:


# all information
data_source = pyaurorax.sources.get_using_identifier(3, format=pyaurorax.FORMAT_FULL_RECORD)
print(data_source)


# # Get statistics for a data source

# In[14]:


# set parameters and get identifier
program = "themis"
platform = "themise"
instrument_type = "footprint"
data_sources = pyaurorax.sources.list(program=program,
                                      platform=platform,
                                      instrument_type=instrument_type)
print(data_sources[0])


# In[15]:


# get stats
stats = pyaurorax.sources.get_stats(identifier, format=pyaurorax.FORMAT_IDENTIFIER_ONLY)
print(stats)
print()
pprint.pprint(stats.__dict__)


# In[ ]: