Skip to content
This repository was archived by the owner on Mar 31, 2022. It is now read-only.

Commit 2d9d057

Browse files
authored
(#51) Fill in the documentation.
1 parent 7916893 commit 2d9d057

File tree

4 files changed

+45
-3
lines changed

4 files changed

+45
-3
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@
33
### What is this?
44

55
This is a repository of a project to investigate the influence of the selection of kernels
6-
for Gaussian processes on the process of modeling light curves of different objects from
7-
the Kepler Archive. For more information on the research, see the
6+
for [Gaussian processes](https://en.wikipedia.org/wiki/Gaussian_process) on the process of
7+
modeling light curves of different objects from the
8+
[Kepler Archive](https://archive.stsci.edu/kepler/data_search/search.php). For more
9+
information on the research, see the
810
[online documentation](https://paveloom-c.github.io/GPKernels).
911

1012
### Wait, why isn't this branch called `master`/`main`?

docs/make.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ makedocs(
1414
# Specify the pages on the left side
1515
pages = [
1616
"Home" => "index.md",
17+
"IDs" => "ids.md",
1718
"Notebooks" => [
1819
"$preamble" => pushfirst!(
1920
map(

docs/src/ids.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# [Object and model identifiers](@id IDs)
2+
3+
### Objects
4+
5+
* [KIC 1430163](https://archive.stsci.edu/kepler/data_search/search.php?target=1430163&action=Search&outputformat=HTML_Table):
6+
* [5th quarter](https://archive.stsci.edu/kepler/preview.php?type=lc&dsn=KPLR001430163-2010174085026)
7+
8+
### Models
9+
10+
* EQP (Exponentiated Quadratic Periodic):
11+
12+
```math
13+
k(\tau) = A \exp\left(-\frac{1}{2}\frac{\tau^2}{l^2}\right) \cos\left(\frac{2 \pi \tau}{P}\right) + \sigma^2 \delta(\tau)
14+
```

docs/src/index.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,29 @@ EditURL = "nothing"
44

55
# GPKernels
66

7-
This work is in progress.
7+
### What is this?
8+
9+
This is the documentation of a project to investigate the influence of the selection of
10+
kernels for [Gaussian processes](https://en.wikipedia.org/wiki/Gaussian_process) on the
11+
process of modeling light curves of different objects from the
12+
[Kepler Archive](https://archive.stsci.edu/kepler/data_search/search.php). For a look under
13+
the hood, visit the [project repository](https://github.com/paveloom-c/GPKernels).
14+
15+
### What objects?
16+
17+
These are the [F-type stars](https://en.wikipedia.org/wiki/F-type_main-sequence_star)
18+
mentioned in the paper
19+
[Mathur et al. (2014)](https://www.mendeley.com/catalogue/6be7d4d7-360f-3acb-9fc5-941020e088da/).
20+
They have published rotation periods, which are interesting to use when testing models. See
21+
more about object identifiers on the [`IDs`](@ref IDs) page.
22+
23+
### Models, huh? What do they look like?
24+
25+
Essentially it's a combination of a periodic kernel, some kernel adding attenuation,
26+
and white noise. That is, these are models of a quasi-periodic process. See the
27+
[`IDs`](@ref IDs) page for a complete list of models used.
28+
29+
### What do I do next from here?
30+
31+
Well, there's a section on the sidebar with all the notebooks, maybe that's worth checking
32+
out.

0 commit comments

Comments
 (0)