Skip to content

Commit

Permalink
docs: more api + typos
Browse files Browse the repository at this point in the history
  • Loading branch information
lgrcia committed May 23, 2024
1 parent ce5e5d8 commit 26c5778
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 6 deletions.
4 changes: 3 additions & 1 deletion docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,6 @@ API

.. autofunction:: coverage

.. autofunction:: period_match
.. autofunction:: period_match

.. autofunction:: phase_coverage
2 changes: 1 addition & 1 deletion docs/tess.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"We see here that a portion of the phase space is covered less than two times, meaning that we would not be able to see two transit of this particular exoplanet. Let's compute this portion"
"We see here that a portion of the phase space is covered less than two times, meaning that we would not be able to see two transits of this particular exoplanet. Let's compute this portion"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion portrait/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ def get_version() -> str:

version: str = get_version()

from portrait.core import coverage, period_match
from portrait.core import coverage, period_match, phase_coverage
5 changes: 2 additions & 3 deletions portrait/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -122,11 +122,10 @@ def coverage(time, gap=0.1, precision=1e-3, n=1):
i.e. with signature :code:`fun(float or array) -> float or array`
"""

phases = jnp.arange(0, 1, precision)
phases = jnp.arange(0.0, 1.0, precision)
overlap_function = phase_coverage(time, phases, gap=gap)

jax.jit

@jax.jit
def fun(period):
"""Compute the phase coverage for a given period
Expand Down

0 comments on commit 26c5778

Please sign in to comment.