diff --git a/docs/index.rst b/docs/index.rst index 6577c43..02ea58b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -88,12 +88,40 @@ the following: Teff = (5770, 80) logg = (4.44, 0.08) feh = (0.00, 0.10) - + + # StarModel needs at least one apparent mag + V = (4.86,0.02) # M_V for sun (Peacut and Mamajek 2013) + dar = Dartmouth_Isochrone() - model = StarModel(dar, Teff=Teff, logg=logg, feh=feh) + model = StarModel(dar, Teff=Teff, logg=logg, feh=feh, V=V) + model.fit() + + # Distance should come out to 10pc + +Adding in a Parallax +-------------------- + + +.. code-block:: python + + #spectroscopic properties (value, uncertainty) + Teff = (5770, 80) + feh = (0.00, 0.10) + + V = (4.86,0.02) # M_V for sun (Peacut and Mamajek 2013) + parallax=(100,1) # Paralax in mas + maxAV = 0.01 + dar = Dartmouth_Isochrone() + + model = StarModel( + dar, Teff=Teff, feh=feh, V=V, parallax=parallax,maxAV=0.01 + ) model.fit() + # Radius should come out to 1 solar radius. + + The model now has a ``samples`` property that contains all of the samples generated by the MultiNest/MCMC chain in a :class:`pandas.DataFrame` object---or more specifically, it contains both the samples generated