Skip to content

Commit a868d5d

Browse files
committed
Update README.md
1 parent cdd251b commit a868d5d

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ PyTransit
44
Fast and easy-to-use tools for exoplanet transit light curve modelling using Python or Fortran.
55

66

7-
from pytransit.gimenez import Gimenez
7+
from pytransit import Gimenez
88
m = Gimenez()
99
f = m.evaluate(t, *pv)
1010

@@ -13,8 +13,13 @@ Fast and easy-to-use tools for exoplanet transit light curve modelling using Pyt
1313
Modules
1414
-------
1515
Transit models
16-
- Optimized and parallelized Fortran implementation of the transit model by A. Gimenez (A&A 450, 1231--1237, 2006).
16+
- Series-expansion based transit model by A. Gimenez (A&A 450, 1231--1237, 2006).
17+
- Quadratic limb-darkening transit model by Mandel & Agol (ApJ 580, L171–L175, 2002).
18+
19+
- Common features
20+
- Optimized and parallelized Fortran implementatios.
1721
- Can calculate the transit model simultaneously for several limb darkening coefficient sets.
22+
- Built-in model interpolation for the modelling of large datasets.
1823
- Built-in supersampling.
1924

2025
Utilities
@@ -41,19 +46,26 @@ Examples
4146
### Basics
4247
Basic usage is simple:
4348

44-
from pytransit.gimenez import Gimenez
49+
from pytransit import Gimenez
4550

4651
m = Gimenez()
4752
f = m.evaluate(t, *pv)
4853

54+
or
55+
56+
from pytransit import MandelAgol
57+
58+
m = MandelAgol()
59+
f = m.evaluate(t, *pv)
60+
4961
Here we first initialize the model accepting the defaults (quadratic limb darkening law, no supersampling,
5062
and the use of all available cores), and then calculate the model for times in the time array `t`, `pv` being
5163
a list containing the system parameters.
5264

5365
For a slightly more useful example, we can do:
5466

5567
import numpy as np
56-
from pytransit.gimenez import Gimenez
68+
from pytransit import Gimenez
5769

5870
t = np.linspace(0.8,1.2,500)
5971
k, t0, p, a, i, e, w = 0.1, 1.01, 4, 8, 0.48*np.pi, 0.2, 0.5*np.pi

0 commit comments

Comments
 (0)