Skip to content

Commit

Permalink
fix(docs): #1 + readme links
Browse files Browse the repository at this point in the history
  • Loading branch information
lgrcia committed May 23, 2024
1 parent 4a78ae2 commit 286ace6
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@
A Python package to compute and visualize observation metrics for periodic events.

In Astronomy, *portrait* is useful to answer the following questions:
- How much of an orbit with period $P$ has been observed given certain observation times? ([tutorial](docs/coverage))
- What period $P$ matches with this list of events? ([tutorial](docs/periodmatch))
- How much of an orbit with period $P$ has been observed given certain observation times? ([tutorial](docs/coverage.ipynb))
- What period $P$ matches with this list of events? ([tutorial](docs/periodmatch.ipynb))
- How a certain target must be observed to cover all orbits with periods lower than $P$ days?
8 changes: 4 additions & 4 deletions docs/tess.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
"source": [
"## Phase coverage\n",
"\n",
"The light curve shows the transits of [TOI-120 b](https://science.nasa.gov/exoplanet-catalog/hd-1397-b/) which has an orbital period of 11.5. Without a surprise, this period is completely covered by the TESS observations, indeed"
"The light curve shows the transits of [TOI-120 b](https://science.nasa.gov/exoplanet-catalog/hd-1397-b/) which has an orbital period of 11.5 days. Obviously this period is completely covered by the TESS observations, indeed"
]
},
{
Expand All @@ -88,7 +88,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"However, since only one sector has been observed, longer period might like coverage. We can compute the phase coverage for a range of period with"
"However, since only one sector has been observed, longer periods might lack coverage. We can compute the phase coverage for a range of period with"
]
},
{
Expand Down Expand Up @@ -120,7 +120,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"A mean estimate of the amount of phase not observed for a range of periods can be optained with"
"A mean estimate of the amount of phase not observed for a range of periods can be obtained with"
]
},
{
Expand Down Expand Up @@ -150,7 +150,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Which mean TESS has about that percent of chances to have missed a longer period transit of TOI-120 b (ignoring all other probabilities). Of course this applies more or less to all target observed in a single TESS sector."
"Which means TESS has about that percent of chances to have missed a longer period transit of TOI-120 b (ignoring all other probabilities). Of course this applies more or less to all targets observed in a single TESS sector."
]
}
],
Expand Down

0 comments on commit 286ace6

Please sign in to comment.