Pipeline to independently derive 'Sun-as-a-star' radial velocity variations using data from the Helioseismic and Magnetic Imager aboard the Solar Dynamic Observatory.
Documentation Site: https://tamarervin.github.io/SolAster/
- update dependencies in conda_env.yml file
- run the following from the folder containing the .yml file
conda env create -f conda_env.yml
- to add new dependencies, update conda_env.yml file
- run the following from the folder containing the .yml file
conda env update -f conda_env.yml
Pipeline can either be used via scripts located in the examples folder or via installation. Additional instructions can be found in the documentation site.
- package installation using pip
- install pip
- install package
pip install SolAster
- Ervin et al. (2021)
- Milbourne et al. (2019)
- Haywood et al. (2016)
- Based on a technique developed by Meunier, Lagrange & Desort (2010) for SoHO/MDI images.
Using our examples requires user specified parameters all of which can be updated in the settings file.
Update the Inputs class to include the correct date frame, cadence, and instrument for your calculations.
- csv_name: name of the CSV file to store calculations (str)
- inst: name of instrument to use for calcuations of RV model (str: either NEID' or 'HARPS-N')
- cadence: querying cadence in seconds (int)
- start_date: start date for calculations (datetime)
- end_date: end date for calculations (datetime)
- diagnostic_plots: whether you would like to plot diagnostic plots (bool)
- save_fig: path to save figures if diagnostic_plots is True (str)
Additionally, users can update paths to store CSV files in settings. The current paths are setup to save directly to the downloaded repository but can be changed for different systems.
Our package produces a CSV or pickle file which includes calculation results of velocity components, model RV variations, and various solar observables. These results are stored as follows.
- date_obs: calculation time in UT (str)
- date_jd: calculation time in JD (float)
- rv_model: model RV variation [m/s]
- v_quiet: quiet-Sun velocity [m/s]
- v_disc: velocity of full solar disk [m/s]
- v_phot: photometric velocity component [m/s]
- v_conv: convective velocity component [m/s]
- f_bright: filling factor due to bright regions [%]
- f_spot: filling factor due to spots [%]
- f: filling factor [%]
- Bobs: unsigned magnetic flux [G]
- vphot_bright: photometric velocity component due to bright regions [m/s]
- vphot_spot: photometric velocity component due to spots [m/s]
- f_small: filling factor due to small regions [%]
- f_large: filling factor due to large regions [%]
- f_network: filling factor due to network regions [%]
- f_plage: filling factor due to plage regions [%]
- quiet_flux: magnetic flux due to quiet-Sun regions [G]
- ar_flux: magnetic flux due to active Sun regions [G]
- conv_flux: magnetic flux due to large active regions [G]
- pol_flux: polarized magnetic flux [G]
- pol_conv_flux: polarized magnetic flux due to large active regions [G]
- vconv_quiet: convective velocity component due to quiet-Sun regions [m/s]
- vconv_large: convective velocity component due to large active regions [m/s]
- vconv_quiet: convective velocity component due to small active regions [m/s]
Examples are hosted here:
-
Sunpy Example: outlines how to use basic Sunpy functions and usages for this package
-
Component Calculations: outlines the corrections and component calculation pipeline
- creates CSV with calculations of magnetic observables and velocity components
-
RV Calculations: outlines calculation of full model RV from velocity components
-
Full Pipeline: full end-to-end pipeline to calculate 'sun-as-a-star' RVs and magnetic observables
- for any issues or bug fixes, please fill out an issue report on the GitHub page
Tamar Ervin: tamarervin@gmail.com
Sam Halverson: samuel.halverson@jpl.nasa.gov