Skip to content

Latest commit

 

History

History
24 lines (18 loc) · 2.13 KB

README.md

File metadata and controls

24 lines (18 loc) · 2.13 KB
Raw

EchelleCCFs Stable Build Status Coverage

The EchelleCCFs package is designed to compute Cross Correlation Functions of stellar spectra from high-resolution Echelle spectragraphs. It is part of the RvSpectML family of Julia packages.
Examples of using it with other RvSpectML packages can be found in the examples and/or notebooks folders of the RvSpectML and RvSpectMLPlots packages.

Examples

The EchelleCCFs package includes a few simplistic tests and one example of applying it to simulated solar spectra from Gilbertson, Ford & Dumusque 2020 which is described in the associated Research Note of the AAS.
The input file for this example is large, so it is not part of the GitHub repository, but is downloaded as part of the build process for the the package. To install the package, download the simulated data and perform a CCF calculation, you can run

import Pkg
Pkg.add("EchelleCCFs")  # Installs EchelleCCFs and required dependancies
using EchelleCCFs       # Loads EchelleCCFs
cd(joinpath(pkgdir(EchelleCCFs),"examples"))  # Change into examples folder
Pkg.activate(".")      # Specify to use Project.toml in examples folder
Pkg.instantiate()      # Installs extra packages for example
include("soap_ccf.jl") # Run example CCF calculation and make plots

To analyze more spectra from the Gilbertson, Ford & Dumusque 2020 dataset, you'll need to download even larger file(s), as illustrated in deps/download_soap_example_from_gilbertson_etal_2020.jl.

Good luck.