The RV Model¶
-
class
radvel.model.
Parameter
(value=None, vary=True, mcmcscale=None)[source]¶ Object to store attributes of each orbital parameter
-
value
¶ float – value of parameter.
-
vary
¶ Bool – True if parameter is allowed to vary in MCMC fits, false if fixed.
-
mcmcscale
¶ float – step size to be used for MCMC fitting
-
-
class
radvel.model.
Parameters
(num_planets, basis='per tc secosw sesinw logk', planet_letters=None)[source]¶ Object to store the orbital parameters.
Parameters to describe a radial velocity orbit stored as an OrderedDict
Parameters: - num_planets (int) – Number of planets in model
- basis (string) – parameterization of orbital parameters. See
radvel.basis.Basis
for a list of valid basis strings. - planet_letters (Dictionary[optional) – custom map to match the planet numbers in the Parameter object to planet letters. Default {1: ‘b’, 2: ‘c’, etc.}. The keys of this dictionary must all be integers.
-
basis
¶ radvel.Basis – Basis object
-
planet_parameters
¶ list – orbital parameters contained within the specified basis
-
num_planets
¶ int – number of planets in the model
Examples
>>> import radvel # create a Parameters object for a 2-planet system with # custom planet number to letter mapping >>> params = radvel.Parameters(2, planet_letters={1:'d', 2:'e'})