add get_spec

Author: behrouzz

README.md

@@ -13,3 +13,37 @@ Install the latest version of *stelspec* from [PyPI](https://pypi.org/project/st
 
 Requirements are *requests*, *numpy* and *pandas*.
 
+## Quick start
+
+Let's start by creating an Elodie instance by passing an object name:
+
+```python
+import stelspec as sp
+
+el = Elodie('HD217014')
+```
+
+You can access two tables, ccf and Spectra, as pandas DataFrame.
+
+```python
+# table: Cross-Correlation Functions
+df_ccf = el.ccf()
+
+# table: Spectra
+df_spc = el.spec()
+```
+
+You can also download spectra as FITS file, whether in *s1d* or *s2d* format:
+
+```python
+# download spectrum FITS file in s1d format
+el.get_spec(dataset=19960831, imanum='0017', path='data/', s1d=True)
+
+# download spectrum FITS file in s2d format
+el.get_spec(dataset=19960831, imanum='0017', path='data/', s1d=Flase)
+```
+
+The same process can be done for Sophie, except that instead of *dataset* and
+*imanum*, you should pass the *seq* number.
+
+For a brief help the structure of FITS files, see [ELODIE](http://atlas.obs-hp.fr/elodie/500/download.html) and [SOPHIE](http://atlas.obs-hp.fr/sophie/spec_help.html).

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="stelspec",
-    version="0.0.3",
+    version="0.0.4",
     author="Behrouz Safari",
     author_email="behrouz.safari@gmail.com",
     description="A python package for retrieving and analysing stellar spectra (ELODIE-SOPHIE Archive)",

stelspec/__init__.py

@@ -1,4 +1,4 @@
 from .core import Elodie, Sophie
 from .columns import desc_el_ccf, desc_el_spec, desc_so_ccf, desc_so_spec
 
-__version__ = "0.0.3"
+__version__ = "0.0.4"

stelspec/core.py

@@ -1,7 +1,14 @@
 """
-Module catalogues
-=================
-This module retrieves data from ELODIE/SOPHIE archive.
+Module core
+===========
+This module retrieves data from ELODIE/SOPHIE archive. It has two classes,
+Elodie and Sophie, both could be constructed by passing an object name.
+
+Help on Elodie FITS files:
+http://atlas.obs-hp.fr/elodie/500/download.html
+
+Help on Sophie FITS files:
+http://atlas.obs-hp.fr/sophie/spec_help.html
 """
 
 import numpy as np
@@ -10,8 +17,8 @@
 from urllib.request import urlretrieve
 from .columns import desc_el_ccf, desc_el_spec, desc_so_ccf, desc_so_spec
 
-def _get_df(base, col_dc, int_cols, float_cols):
-    url = base + str(list(col_dc.keys())).replace("'", "").replace(" ", "")[1:-1]
+def _get_df(url_, col_dc, int_cols, float_cols):
+    url = url_ + str(list(col_dc.keys())).replace("'", "").replace(" ", "")[1:-1]
     req = requests.request('GET', url)
     r = req.content.decode('utf-8')
     lines = r.splitlines()
@@ -41,30 +48,31 @@ def __init__(self, obj):
         spect : Spectra table
         """
         self.obj = obj
+        self.BASE = 'http://atlas.obs-hp.fr/elodie/fE.cgi?'
 
     def ccf(self):
         """
         Elodie Cross-Correlation Functions table
         """
-        BASE = f'http://atlas.obs-hp.fr/elodie/fE.cgi?n=e501&o={self.obj}&ob=jdb&a=csv&&d='
+        url_ = self.BASE + f'n=e501&o={self.obj}&ob=jdb&a=csv&&d='
         int_cols = ['datenuit']
         float_cols = ['jdb','exptim','sn','vfit','sigfit','ampfit','ctefit']
-        url, df = _get_df(BASE, desc_el_ccf, int_cols, float_cols)
+        url, df = _get_df(url_, desc_el_ccf, int_cols, float_cols)
         print(url.replace('a=csv', 'a=htab'))
         return df
 
     def spec(self):
         """
         Elodie Spectra table
         """
-        BASE = f'http://atlas.obs-hp.fr/elodie/fE.cgi?o={self.obj}&a=csv&d='
+        url_ = self.BASE + f'o={self.obj}&a=csv&d='
         int_cols = ['dataset']
         float_cols = ['exptime','sn','vfit','sigfit','ampfit']
-        url, df = _get_df(BASE, desc_el_spec, int_cols, float_cols)
+        url, df = _get_df(url_, desc_el_spec, int_cols, float_cols)
         print(url.replace('a=csv', 'a=htab'))
         return df
 
-    def get_spec(dataset, imanum, s1d=True, path=None):
+    def get_spec(self, dataset, imanum, path=None, s1d=True):
         BASE = 'http://atlas.obs-hp.fr/elodie/E.cgi?'
         s1 = '&z=s1d' if s1d else ''
         PAR1 = f'&c=i&o=elodie:{dataset}/{imanum}'
@@ -90,32 +98,33 @@ def __init__(self, obj):
         spect : Spectra table
         """
         self.obj = obj
+        self.BASE = 'http://atlas.obs-hp.fr/sophie/sophie.cgi?'
 
     def ccf(self):
         """
         Sophie Cross-Correlation Functions table
         """
-        BASE = f'http://atlas.obs-hp.fr/sophie/sophie.cgi?n=sophiecc&ob=bjd&a=csv&o={self.obj}&d='
+        url_ = self.BASE + f'n=sophiecc&ob=bjd&a=csv&o={self.obj}&d='
         int_cols = ['seq','sseq','slen','nexp','expno','ccf_offline','maxcpp','lines']
         float_cols = ['bjd','rv','err','dvrms','fwhm','span','contrast','sn26']
-        url, df = _get_df(BASE, desc_so_ccf, int_cols, float_cols)
+        url, df = _get_df(url_, desc_so_ccf, int_cols, float_cols)
         print(url.replace('a=csv', 'a=htab'))
         return df
 
     def spec(self):
         """
         Sophie Spectra table
         """
-        BASE = f'http://atlas.obs-hp.fr/sophie/sophie.cgi?n=sophie&a=csv&ob=bjd&c=o&o={self.obj}&d='
+        url_ = self.BASE + f'n=sophie&a=csv&ob=bjd&c=o&o={self.obj}&d='
         int_cols = ['seq','sseq','slen','nexp','expno']
         float_cols = ['bjd','sn26','exptime']
-        url, df = _get_df(BASE, desc_so_spec, int_cols, float_cols)
+        url, df = _get_df(url_, desc_so_spec, int_cols, float_cols)
         print(url.replace('a=csv', 'a=htab'))
         return df
 
-    def get_spec(seq, path=None):
-        url = f'http://atlas.obs-hp.fr/sophie/sophie.cgi?c=i&a=mime:application/fits&o=sophie:[s1d,{seq}]'
-        filename = f'sophie_[s1d,{seq}].fits'
+    def get_spec(self, seq, path=None, s1d=True):
+        s1d = 's1d' if s1d==True else 'e2ds'
+        url = self.BASE + f'c=i&a=mime:application/fits&o=sophie:[{s1d},{seq}]'
+        filename = f'sophie_[{s1d},{seq}].fits'
         path = '' if path is None else path
         urlretrieve(url, path+filename)
-