README.md

An implementation of common line profile indicators measured from the cross-correlation function (CCF).

To install

Directly from PyPI

pip install iCCF

Or from source

git clone https://github.com/j-faria/iCCF.git
cd iCCF
python setup.py install 

You can append --user to both commands (pip and python ...) in case you don't have root access.

All the indicators are based on the works of others. Please cite these works if you use iCCF.

• Queloz et al 2001
• Boisse et al 2011
• Nardetto et al 2006
• Figueira et al 2013
• Santerne et al 2015
• Lanza et al 2018

See also

• Similar codes were developed by Figueira et al. A&A 557, A93 (2013)
  with a Python package available here (described in Appendix A of Santos et al. A&A 566, A35 (2014))

• A similar package (in IDL) was developed by Lanza et al. A&A 616, A155 (2018).
  It is available here.