Basis#

class simppler.basis.Basis[source]#

Abstract base class for an orbital basis

abstractmethod from_synth(p, num_planets)[source]#

Function converting parameters from the SynthBasis basis to the current basis.

Parameters:
  • p (dict)

  • num_planets (int)

Return type:

dict

abstractmethod to_synth(p, num_planets)[source]#

Function converting parameters from the current basis to the SynthBasis basis.

Parameters:
  • p (dict)

  • num_planets (int)

Return type:

dict

class simppler.basis.DefaultBasis[source]#

Default basis

Fitting basis used by default in RV models. The differences with the SynthBasis are:

  • The time of conjunction (or transit for transiting planets) tc is used instead of the time of periastron tp. This parameter is better defined for circular orbit.

  • e and w are replaced with secosw and sesinw (\(\sqrt{e}\cos{\omega}\), \(\sqrt{e}\sin{\omega}\))

from_synth(p_synth, num_planets)[source]#

Function converting parameters from the SynthBasis basis to the current basis.

Parameters:
  • p_synth (dict)

  • num_planets (int)

to_synth(p, num_planets)[source]#

Function converting parameters from the current basis to the SynthBasis basis.

Parameters:
  • p (dict)

  • num_planets (int)

class simppler.basis.EccBasis[source]#

Ecc Basis

Same as the SynthBasis, but e and w are fitted directly instead of secosw and sesinw.

from_synth(p_synth, num_planets)[source]#

Function converting parameters from the SynthBasis basis to the current basis.

Parameters:
  • p_synth (dict)

  • num_planets (int)

Return type:

dict

to_synth(p, num_planets)[source]#

Function converting parameters from the current basis to the SynthBasis basis.

Parameters:
  • p (dict)

  • num_planets (int)

Return type:

dict

class simppler.basis.LogKBasis[source]#

LogK Basis

Same as the DefaultBasis, but the logarithm of the semi-amplitude is fitted instead of the semi-amplitude.

from_synth(p_synth, num_planets)[source]#

Function converting parameters from the SynthBasis basis to the current basis.

Parameters:
  • p_synth (dict)

  • num_planets (int)

to_synth(p, num_planets)[source]#

Function converting parameters from the current basis to the SynthBasis basis.

Parameters:
  • p (dict)

  • num_planets (int)

class simppler.basis.LogPerBasis[source]#

LogPer Basis

Same as the DefaultBasis, but the logarithm of the period is fitted instead of the semi-amplitude.

from_synth(p_synth, num_planets)[source]#

Function converting parameters from the SynthBasis basis to the current basis.

Parameters:
  • p_synth (dict)

  • num_planets (int)

to_synth(p, num_planets)[source]#

Function converting parameters from the current basis to the SynthBasis basis.

Parameters:
  • p (dict)

  • num_planets (int)

class simppler.basis.SynthBasis[source]#

Synth basis

This is the ‘synth’ basis from radvel, which is passed to the Keplerian solver. All Basis classes must be able to convert to and from this basis with to_synth() and from_synth() methods.

The parameters are:

  • per: Period

  • tp: Time of periastron

  • e: Eccentricity

  • w: Argument of periastron

  • k: Semi-amplitude

from_synth(p_synth, num_planets)[source]#

Function converting parameters from the SynthBasis basis to the current basis.

Parameters:
  • p_synth (dict)

  • num_planets (int)

to_synth(p, num_planets)[source]#

Function converting parameters from the current basis to the SynthBasis basis.

Parameters:
  • p (dict)

  • num_planets (int)