Welcome to sunburn’s documentation!

sunburn is a Python package aimed at facilitating the data analysis of ultraviolet spectra obtained with the Hubble Space Telescope, and more specifically designed towards the study of transiting exoplanets. The code is completely object-oriented and designed to be used with Python scripts and Jupyter Notebooks. If you find any bugs or have questions and feature requests, feel free to submit an issue on GitHub. sunburn is fully compatible with Python 3, and may have incompatibility issues with Python 2.

Installation

sunburn currently works with Python 3; compatibility with Python 2 was not tested.

Dependencies

  • numpy >= 1.12
  • scipy >= 0.19
  • matplotlib >= 2.0
  • astropy >= 2.0.2
  • astroquery >= 0.3.7.dev4234
  • astroplan

Note: The development version of astroquery is necessary because of a specific implementation of queries to the NASA Exoplanet Archive. In order to install this development version, you will have to build it from source. In the near future this may not be necessary anymore because astroquery will eventually consolidate the development version into the stable version.

Build from source

Clone the repository:

git clone https://github.com/ladsantos/sunburn.git

Navigate to the source code and install it in your Python environment:

cd sunburn
python setup.py install

API

sunburn.hst_observation module

sunburn.analysis module

sunburn.spectroscopy module

sunburn.tools module

Indices and tables