Skip to content

Commit f03e858

Browse files
committed
Update documentation for new rv output
1 parent 89d138a commit f03e858

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

README.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,15 @@ To compute the TTV properties for one or more planets:
2828
- the time step for the integration in days,
2929
- and the end point for integration in days.
3030

31-
The function ``ttvfast.ttvfast`` returns five lists:
31+
The function ``ttvfast.ttvfast`` returns a dictionary containing ``positions`` and ``rv``. The ``positions`` entry is a tuple of:
3232

3333
1. a list of integer indices for which values correspond to which planet,
3434
2. a list of integers defining the epoch,
3535
3. a list of times,
3636
4. a list of rsky values, and
3737
5. a list of vsky values.
3838

39-
For more details, see the original C module's documentation: https://github.com/kdeck/TTVFast/blob/master/c_version/README
39+
The optional ``rv_times`` parameter takes a list of RV times on which the RV is to be calculated. If so the ``rv`` entry in the output
40+
dictionary is populated with a list of RV values, and otherwise ``None``.
4041

41-
Currently the RV output portion of ``TTVFast`` is not supported.
42+
For more details, see the original C module's documentation: https://github.com/kdeck/TTVFast/blob/master/c_version/README

0 commit comments

Comments
 (0)