Updated documentation.

hpparvi · Sep 18, 2020 · ae1eaf3 · ae1eaf3
1 parent e2430f8
commit ae1eaf3
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 3 deletions.
diff --git a/doc/source/api/models/osmodel.rst b/doc/source/api/models/osmodel.rst
@@ -0,0 +1,10 @@
+Oblate star model
+-----------------
+
+.. autoclass:: pytransit.OblateStarModel
+
+   .. automethod:: __init__
+   .. automethod:: set_data
+   .. automethod:: evaluate
+   .. automethod:: evaluate_ps
+   .. automethod:: evaluate_pv
diff --git a/doc/source/api/models/rrmodel.rst b/doc/source/api/models/rrmodel.rst
@@ -0,0 +1,10 @@
+Road Runner model
+-----------------
+
+.. autoclass:: pytransit.RoadRunnerModel
+
+   .. automethod:: __init__
+   .. automethod:: set_data
+   .. automethod:: evaluate
+   .. automethod:: evaluate_ps
+   .. automethod:: evaluate_pv
diff --git a/doc/source/api/transit_models.rst b/doc/source/api/transit_models.rst
@@ -3,10 +3,12 @@ Transit models
 .. toctree::
    :maxdepth: 4
 
+   models/rrmodel
    models/uniform
    models/uniformcl
    models/quadratic
    models/quadraticcl
+   models/osmodel
    models/general
    models/qpower2
    models/chromosphere
diff --git a/doc/source/implemented_models.rst b/doc/source/implemented_models.rst
@@ -4,6 +4,15 @@ Implemented transit models
 PyTransit implements a set of transit models that all share a common interface that is described in more detail in
 :doc:`models`.
 
+Road Runner model
+-----------------
+RoadRunner (:class:`pytransit.RoadRunnerModel`)  is a fast and flexible transit model presented in Parviainen (accepted to MNRAS 2020).
+I'll write a proper documentation soon, but these example notebooks should help you up to speed until then
+
+- `Example 1: basics <https://github.com/hpparvi/PyTransit/blob/master/notebooks/roadrunner/roadrunner_model_example_1.ipynb>`_
+- `Example 2: custom limb darkening <https://github.com/hpparvi/PyTransit/blob/master/notebooks/roadrunner/roadrunner_model_example_2.ipynb>`_
+- `Example 3: LDTk limb darkening model <https://github.com/hpparvi/PyTransit/blob/master/notebooks/roadrunner/roadrunner_model_example_3.ipynb>`_
+
 Uniform model
 -------------
 
@@ -22,10 +31,10 @@ in `Mandel & Agol (ApJ 580, 2001) <https://iopscience.iop.org/article/10.1086/34
 
 - `Quadratic model example <https://github.com/hpparvi/PyTransit/blob/master/notebooks/example_quadratic_model.ipynb>`_
 
-**Notes:**
+Oblate star model
+-----------------
 
-- The current implementation requires the minimum and maximum radius ratios to be given. **The model evaluates to unity
-  for radius ratios outside these limits.**
+TBD
 
 Power-2 model
 -------------