solyaris 0.1.0__tar.gz

solyaris-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Khaled Al Moulla
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

solyaris-0.1.0/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.1
+Name: solyaris
+Version: 0.1.0
+Summary: Order-by-order radial-velocity extraction and differential-extinction correction of Sun-as-a-star observations.
+Home-page: https://github.com/almoulla/solyaris
+Author: Khaled Al Moulla
+Author-email: khaled.almoulla@gmail.com
+License: MIT License
+Classifier: Development Status :: 1 - Planning
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: astropy>=7.0.0
+Requires-Dist: barycorrpy>=0.4.4
+Requires-Dist: iCCF>=0.4.15
+Requires-Dist: numpy>=2.2.4
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: tqdm>=4.67.1
+
+<p align="center">
+    <img width="500" src="https://github.com/almoulla/solyaris/blob/main/solyaris_logo.png?raw=true"/>
+</p>
+
+`solyaris` facilitates order-by-order radial-velocity extraction and differential-extinction correction of Sun-as-a-star observations.
+
+## Installation
+
+```
+pip install solyaris
+```

solyaris-0.1.0/README.md

@@ -0,0 +1,11 @@
+<p align="center">
+    <img width="500" src="https://github.com/almoulla/solyaris/blob/main/solyaris_logo.png?raw=true"/>
+</p>
+
+`solyaris` facilitates order-by-order radial-velocity extraction and differential-extinction correction of Sun-as-a-star observations.
+
+## Installation
+
+```
+pip install solyaris
+```

solyaris-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

solyaris-0.1.0/setup.py

@@ -0,0 +1,28 @@
+from setuptools import find_packages, setup
+
+with open('README.md') as file:
+    long_description = file.read()
+
+setup(
+    name='solyaris',
+    version='0.1.0',
+    author='Khaled Al Moulla',
+    author_email='khaled.almoulla@gmail.com',
+    description='Order-by-order radial-velocity extraction and differential-extinction correction of Sun-as-a-star observations.',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    url='https://github.com/almoulla/solyaris',
+    license='MIT License',
+    packages=find_packages(),
+    python_requires='>=3.10',
+    install_requires=['astropy>=7.0.0'   ,
+                      'barycorrpy>=0.4.4',
+                      'iCCF>=0.4.15'     ,
+                      'numpy>=2.2.4'     ,
+                      'pandas>=2.2.3'    ,
+                      'tqdm>=4.67.1'     ],
+    classifiers=["Development Status :: 1 - Planning"    ,
+                 "Intended Audience :: Science/Research" ,
+                 "License :: OSI Approved :: MIT License",
+                 "Programming Language :: Python :: 3"   ]
+)

solyaris-0.1.0/solyaris/__init__.py

@@ -0,0 +1,8 @@
+__version__ = '0.1.0'
+__author__  = 'Khaled Al Moulla'
+
+from .solyaris import SOLYARIS
+from .solyaris import save
+from .solyaris import load
+
+__all__ = ['SOLYARIS', 'save', 'load']

solyaris-0.1.0/solyaris/compute_berv_and_herv.py

@@ -0,0 +1,34 @@
+import astropy.constants as     ac
+from   astropy.time      import Time
+import barycorrpy
+import numpy             as     np
+from   tqdm              import tqdm
+import warnings
+warnings.filterwarnings('ignore')
+
+def compute_berv_and_herv(obsname, date_obs, exp_time, photocen):
+
+    # Nr. of observations
+    Nobs = len(date_obs)
+
+    # Empty arrays
+    berv_val = np.empty(Nobs, dtype=float)*np.nan
+    herv_val = np.empty(Nobs, dtype=float)*np.nan
+
+    # Loop observations
+    print('Computing BERV and HERV ...')
+    for i in tqdm(range(Nobs)):
+
+        # Compute gravitational redshift of the Sun
+        gr_sun = (ac.G.value * ac.M_sun.value) / (ac.R_sun.value * ac.c.value)
+
+        # Compute BERV and HERV
+        jd_utc_cen  = Time(date_obs[i], format='isot').jd + exp_time[i]*photocen[i]/(60*60*24)
+        berv_val[i] = barycorrpy.get_BC_vel(JDUTC=jd_utc_cen, obsname=obsname, SolSystemTarget='Sun'                 )[0][0]
+        herv_val[i] = barycorrpy.get_BC_vel(JDUTC=jd_utc_cen, obsname=obsname, SolSystemTarget='Sun', predictive=True)[0][0] + berv_val[i] - gr_sun
+
+    # Convert from m/s to km/s
+    berv_val *= 1e-3
+    herv_val *= 1e-3
+
+    return berv_val, herv_val

solyaris-0.1.0/solyaris/compute_solar_coordinates.py

@@ -0,0 +1,51 @@
+from   astropy             import units as u
+from   astropy.coordinates import AltAz, Angle, EarthLocation, get_body, solar_system_ephemeris
+from   astropy.time        import Time
+from   datetime            import datetime, timedelta
+import numpy               as     np
+from   tqdm                import tqdm
+import warnings
+warnings.filterwarnings('ignore')
+
+def compute_solar_coordinates(obsname, date_obs, exp_time, photocen):
+
+    # Nr. of observations
+    Nobs = len(date_obs)
+
+    # Empty arrays
+    alph_val = np.empty(Nobs, dtype=float)*np.nan
+    delt_val = np.empty(Nobs, dtype=float)*np.nan
+    airm_val = np.empty(Nobs, dtype=float)*np.nan
+
+    # Loop observations
+    print('Computing solar coordinates ...')
+    for i in tqdm(range(Nobs)):
+
+        # Get date at start, end and photocenter of observation
+        date_start = datetime.strptime(date_obs[i], '%Y-%m-%dT%H:%M:%S.%f')
+        date_end = date_start + timedelta(days=0, seconds=exp_time[i])
+        date_photocenter = date_start + timedelta(days=0, seconds=exp_time[i]*photocen[i])
+        
+        # Get Sun coordinates
+        solar_system_ephemeris.set('de432s') # use JPL ephemeredis
+        loc = EarthLocation.of_site(obsname)
+        obstime = Time(date_photocenter)
+        sun_coord = get_body('sun', obstime, loc)
+        sun_coord_string = sun_coord.to_string('hmsdms')
+        alpha = sun_coord_string.split('s')[0]
+        delta = sun_coord_string.split('s')[1].strip().replace('d',':').replace('m',':').replace('+', '')
+
+        # Convert alpha and delta to decimal degrees
+        alph_val[i] = Angle(alpha, unit=u.hour  ).to(u.degree).value
+        delt_val[i] = Angle(delta, unit=u.degree)             .value
+        
+        # Compute airmass
+        time_start = Time(date_start)
+        time_end = Time(date_end)
+        sun_altaz_start = sun_coord.transform_to(AltAz(obstime=time_start, location=loc))
+        sun_altaz_end = sun_coord.transform_to(AltAz(obstime=time_end, location=loc))
+        airm_start = sun_altaz_start.secz.value
+        airm_end = sun_altaz_end.secz.value
+        airm_val[i] = airm_start*(1-photocen[i]) + airm_end*photocen[i]
+
+    return alph_val, delt_val, airm_val

solyaris-0.1.0/solyaris/extract_ccf.py

@@ -0,0 +1,24 @@
+from   astropy.io import fits
+import numpy      as     np
+import warnings
+warnings.filterwarnings('ignore')
+
+def extract_ccf(file, instrument):
+
+    # ESPRESSO
+    if instrument == 'espresso':
+
+        # Load FITS file
+        with fits.open(file) as hdul:
+
+            # Header
+            header = hdul[0].header
+
+            # Extract CCF data
+            ccf_val = hdul[1].data
+            ccf_err = hdul[2].data
+            vstart  = header['HIERARCH ESO RV START']
+            vstep   = header['HIERARCH ESO RV STEP' ]
+            vgrid   = vstart + vstep * np.arange(ccf_val.shape[1])
+
+    return vgrid, ccf_val, ccf_err

solyaris-0.1.0/solyaris/extract_header_keywords.py

@@ -0,0 +1,52 @@
+from   astropy.io import fits
+import pandas     as     pd
+from   tqdm       import tqdm
+import warnings
+warnings.filterwarnings('ignore')
+
+def extract_header_keywords(files, instrument, Norder):
+
+    # Nr. of files
+    Nfile = len(files)
+
+    # Loop files
+    print(f'Extracting header keywords ...')
+    for i in tqdm(range(Nfile)):
+
+        # Load FITS file
+        with fits.open(files[i]) as hdul:
+
+            # Header
+            header = hdul[0].header
+
+            # ESPRESSO
+            if instrument == 'espresso':
+
+                # Extract header keywords
+                header_dict = {}
+                header_dict['file'    ] = header['ARCFILE'                               ]
+                header_dict['targ'    ] = header['HIERARCH ESO OBS TARG NAME'            ]
+                header_dict['date'    ] = header['DATE-OBS'                              ][:10]
+                header_dict['date_obs'] = header['DATE-OBS'                              ]
+                header_dict['ins_mode'] = header['HIERARCH ESO INS MODE'                 ]
+                header_dict['obj_type'] = header['HIERARCH ESO PRO REC1 RAW1 CATG'       ]
+                header_dict['exp_time'] = header['EXPTIME'                               ]
+                header_dict['photocen'] = header['HIERARCH ESO QC TMMEAN USED'           ]
+                header_dict['alph_val'] = header['HIERARCH ESO TEL5 TARG ALPHA'          ]
+                header_dict['delt_val'] = header['HIERARCH ESO TEL5 TARG DELTA'          ]
+                header_dict['airm_val'] = header['HIERARCH ESO TEL5 AIRM START'          ]*(1-header_dict['photocen']) + header['HIERARCH ESO TEL5 AIRM END']*header_dict['photocen']
+                header_dict['berv_val'] = header['HIERARCH ESO QC BERV'                  ]
+                header_dict['time_jdb'] = header['HIERARCH ESO QC BJD'                   ]
+                header_dict['vrad_val'] = header['HIERARCH ESO QC CCF RV'                ]
+                header_dict['vrad_err'] = header['HIERARCH ESO QC CCF RV ERROR'          ]
+                for j in range(Norder):
+                    header_dict[f'snr_{j+1}'] = header[f'HIERARCH ESO QC ORDER{j+1} SNR' ]
+
+        # Initiate DataFrame
+        if i == 0:
+            df = pd.DataFrame(columns=header_dict.keys())
+
+        # Populate DataFrame
+        df.loc[i] = header_dict
+
+    return df

solyaris-0.1.0/solyaris/extract_order_by_order_rv.py

@@ -0,0 +1,32 @@
+import iCCF
+import numpy    as     np
+from   tqdm     import tqdm
+import warnings
+warnings.filterwarnings('ignore')
+
+from .extract_ccf import extract_ccf
+
+def extract_order_by_order_rv(files, instrument, Norder):
+
+    # Nr. of files and orders
+    Nfile  = len(files)
+    Norder = Norder
+
+    # Empty arrays
+    vrad_val_ord = np.empty((Nfile, Norder+1), dtype=float)*np.nan
+    vrad_err_ord = np.empty((Nfile, Norder+1), dtype=float)*np.nan
+
+    # Loop files
+    print('Extracting order-by-order RV ...')
+    for i in tqdm(range(Nfile)):
+
+        # Extract order-by-order CCF
+        vgrid, ccf_val, ccf_err = extract_ccf(files[i], instrument)
+
+        # Extract order-by-order RV
+        for j in range(Norder+1):
+            iccf = iCCF.Indicators(vgrid, ccf_val[j], ccf_err[j])
+            vrad_val_ord[i,j] = iccf.RV
+            vrad_err_ord[i,j] = iccf.RVerror
+
+    return vrad_val_ord, vrad_err_ord

solyaris-0.1.0/solyaris/solyaris.py

@@ -0,0 +1,81 @@
+import pickle
+
+from .compute_berv_and_herv     import compute_berv_and_herv
+from .compute_solar_coordinates import compute_solar_coordinates
+from .extract_header_keywords   import extract_header_keywords
+from .extract_order_by_order_rv import extract_order_by_order_rv
+
+class SOLYARIS:
+
+    def __init__(self, instrument, id=None):
+
+        # Instrument and SOLYARIS object ID
+        self.instrument = instrument
+        if id is None:
+            self.id = instrument
+
+        # ESPRESSO
+        if self.instrument == 'espresso':
+            self.Norder     = 170
+            self.obsname    = 'Paranal Observatory'
+
+    def add_data(self, files=None):
+
+        self.files = files
+
+        return None
+
+    def extract_header_keywords(self):
+
+        self.table = extract_header_keywords(self.files, self.instrument, self.Norder)
+
+        return None
+
+    def extract_order_by_order_rv(self):
+
+        vrad_val_ord, vrad_err_ord = extract_order_by_order_rv(self.files, self.instrument, self.Norder)
+
+        for j in range(self.Norder+1):
+            self.table[f'vrad_val_{j+1}'] = vrad_val_ord[:,j]
+            self.table[f'vrad_err_{j+1}'] = vrad_err_ord[:,j]
+
+        return None
+
+    def compute_solar_coordinates(self):
+        
+        alph_val, delt_val, airm_val = compute_solar_coordinates(self.obsname, self.table.date_obs.values, self.table.exp_time.values, self.table.photocen.values)
+
+        self.table.rename(columns={'alph_val': 'alph_drs'}, inplace=True)
+        self.table.rename(columns={'delt_val': 'delt_drs'}, inplace=True)
+        self.table.rename(columns={'airm_val': 'airm_drs'}, inplace=True)
+        
+        self.table.insert(self.table.columns.get_loc('alph_drs')+1, 'alph_val', alph_val)
+        self.table.insert(self.table.columns.get_loc('delt_drs')+1, 'delt_val', delt_val)
+        self.table.insert(self.table.columns.get_loc('airm_drs')+1, 'airm_val', airm_val)
+
+        return None
+
+    def compute_berv_and_herv(self):
+
+        berv_val, herv_val = compute_berv_and_herv(self.obsname, self.table.date_obs.values, self.table.exp_time.values, self.table.photocen.values)
+
+        self.table.rename(columns={'berv_val': 'berv_drs'}, inplace=True)
+        
+        self.table.insert(self.table.columns.get_loc('berv_drs')+1, 'berv_val', berv_val)
+        self.table.insert(self.table.columns.get_loc('berv_drs')+2, 'herv_val', herv_val)
+
+        return None
+
+    def export_table(self):
+
+        self.table.to_csv(self.id+'.csv', index=False)
+
+        return None
+
+def save(solyaris):
+
+    return pickle.dump(solyaris, open(solyaris.id+'.solyaris', 'wb'))
+
+def load(solyaris):
+
+    return pickle.load(open(solyaris, 'rb'))

solyaris-0.1.0/solyaris.egg-info/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.1
+Name: solyaris
+Version: 0.1.0
+Summary: Order-by-order radial-velocity extraction and differential-extinction correction of Sun-as-a-star observations.
+Home-page: https://github.com/almoulla/solyaris
+Author: Khaled Al Moulla
+Author-email: khaled.almoulla@gmail.com
+License: MIT License
+Classifier: Development Status :: 1 - Planning
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: astropy>=7.0.0
+Requires-Dist: barycorrpy>=0.4.4
+Requires-Dist: iCCF>=0.4.15
+Requires-Dist: numpy>=2.2.4
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: tqdm>=4.67.1
+
+<p align="center">
+    <img width="500" src="https://github.com/almoulla/solyaris/blob/main/solyaris_logo.png?raw=true"/>
+</p>
+
+`solyaris` facilitates order-by-order radial-velocity extraction and differential-extinction correction of Sun-as-a-star observations.
+
+## Installation
+
+```
+pip install solyaris
+```

solyaris-0.1.0/solyaris.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+README.md
+setup.py
+solyaris/__init__.py
+solyaris/compute_berv_and_herv.py
+solyaris/compute_solar_coordinates.py
+solyaris/extract_ccf.py
+solyaris/extract_header_keywords.py
+solyaris/extract_order_by_order_rv.py
+solyaris/solyaris.py
+solyaris.egg-info/PKG-INFO
+solyaris.egg-info/SOURCES.txt
+solyaris.egg-info/dependency_links.txt
+solyaris.egg-info/requires.txt
+solyaris.egg-info/top_level.txt

solyaris-0.1.0/solyaris.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

solyaris-0.1.0/solyaris.egg-info/requires.txt

@@ -0,0 +1,6 @@
+astropy>=7.0.0
+barycorrpy>=0.4.4
+iCCF>=0.4.15
+numpy>=2.2.4
+pandas>=2.2.3
+tqdm>=4.67.1

solyaris-0.1.0/solyaris.egg-info/top_level.txt

@@ -0,0 +1 @@
+solyaris