Welcome to pyodine’s documentation!

The pyodine package helps you to determine precise Radial Velocities (RVs) from stellar spectra, using the iodine (I2) cell method developed by Butler et al. (1996). We aimed to build it in a flexible, modular and well-structured way, so as to make it (comparably) comprehensible and allow an easy and quick adaptation to different instruments.

Thus far, we have successfully tested pyodine on spectra from two different instruments, the Hamilton spectrograph at Lick observatory and the SONG spectrograph site on Tenerife.

Check out how to install the project, or take a look at the Overview of main routines section for a first glimpse into the main routines. In our Tutorial you can learn how to use pyodine on spectra from the SONG telescope (start with Prepare the environment).

Note

This project is under active development.

Quick start

• Installation
• Overview of main routines
  • Create a deconvolved stellar template
  • Model a single observation
  • Model multiple observations
  • Combine chunk velocities to RV timeseries
• Overview of the utilities modules
  • conf.py
  • load_pyodine.py
  • pyodine_parameters.py
  • timeseries_parameters.py
• Class objects for data storage
  • The Observation parent class
  • Star and instrument representation
  • Combined velocity results
• Modelling-related class objects
  • The MultiGaussian LSF
  • The linear wavelength model
  • The spectrum model
• Code structure

Tutorial

• Prepare the environment
• Create a deconvolved stellar template
• Model the stellar I2 observations
• Weight and combine the chunk velocities
• Create stellar template from reference spectrum
• Clean observations from the I2

Set up a new instrument

• Add a new I2 atlas
• Setup your instrument’s utilities module

Notes and issues

• Important notes and previously encountered issues
• Acknowledgements

Indices and tables

• Index

• Module Index

• Search Page