Skip to content

Simulating high-resolution cross-correlation spectroscopy of exoplanet atmospheres.

License

Notifications You must be signed in to change notification settings

arjunsavel/scope

Repository files navigation

scope

Documentation Status License: MIT Code style: black pre-commit CodeQL Tests codecov Maintainability

Simulating cross-correlation of planetary emission.

installation

To install from source, run

python3 -m pip install -U pip
python3 -m pip install -U setuptools setuptools_scm pep517
git clone https://github.com/arjunsavel/scope
cd scope
python3 -m pip install -e .

You'll also need to download some data files. Currently, these data files are about 141 MB large. You can download them (to the correct directory, even!) with the following:

cd src/scope
chmod +x download_data.bash
./download_data.bash

This will create a data directory and plop the relevant files into it.

workflow

The bulk of scope's high-level functionality is contained in scope/run_simulation.py. For a detailed tutorial, see the documentation.

To run a large set of models, edit scope/grid.py to define a parameter grid. This grid is then used to run a set of simulations in scope/run_simulation.py; the command python run_simulation.py n will run a simulation in the defined grid at index n.

The scope.run_simulation.make_data function can be used to simulate a single high-resolution dataset. To simulate detection significances, use scope.run_simulation.calc_log_likelihood.

Running the script requires an exoplanet spectrum, stellar spectrum, and telluric spectrum. Default parameters are currently correspond to the exoplanet WASP-77Ab.

Once completed, scope.run_simulation.calc_log_likelihood will output:

  • simdata file: the simulated flux cube with PCA performed. That is, the principle components with the largest variance have been removed.
  • nopca_simdata file: the simulated flux cube, including all spectral components (exoplanet, star, blaze function, tellurics).
  • A_noplanet file: the simulated flux cube with the lowest-variance principle component removed.
  • lls_ file: the log-likelihood surface for the simulated flux cube, as a Kp--Vsys map.
  • ccfs_ file: the cross-correlation function for the simulated flux cube, as a Kp--Vsys map.