Platos Closet
Hello World! Welcome to the documentation for platos_closet, a Python package for telling if a planet from the solar system could be detected by PLATO space mission.
platos_closet is written to be simple and fast since only relies on numpy. It takes into account noise levels
representative for PLATO space mission. More details can be found in the PLATO Definition Study Report (Red Book)
platos_closet was developed as a part of the CODE/ASTRO workshop by the authors.
Detection Functions
Function to see if a planet is detectable
- class detection.Planet(name, depth, duration, number=3)
Defines a set of parameters for planets in our solar system.
- Parameters:
name (str) – Name of the planet.
depth (int) – Transit depth in ppm.
duration (int) – Transit duration in hours.
number (int) – Number of transits.
- detectability_check()
Performs the detectability check for an array of planet data.
- Parameters:
planets_data (list) – List of tuples containing planet data in the format (name, depth, duration).
- Returns:
None. Prints the detection results on the screen.
- is_detectable(nsr, nsr_plato=34)
Determines if the planet is detectable based on the noise level.
- Parameters:
nsr (float) – Noise level of the planet transit signal at detector level.
nsr_plato (float, optional) – Threshold noise level for detection. Defaults to 34 ppm sqrt(hr).
- Returns:
‘Detectable planet’ or ‘Non-detectable planet’.
- Return type:
str
- noise_level(eta=7.1)
Calculates the noise level of the planet transit signal at detector level.
- Parameters:
eta (float, optional) – Statistical significance value adopted for PLATO. Defaults to 7.1.
- Returns:
The noise level of the planet transit signal at detector level.
- Return type:
float
Installation
For Linux users
To install platos_closet you just have to type from the terminal:
$ pip install platos_closet
The only dependency of platos_closet is numpy. It will be installed
automathically after you install platos_closet. However, if you already
have it, it would be useful to have its latest version. For doing that, you just
type
$ pip install numpy --upgrade
Tutorial
The following tutorial walk you through the process of tellign if a planet of our solar sytem could create a transit signal strong enough to be detectable fro PLATO space mission.