Skip to content

Commit

Permalink
docs: add motivation and templates + nicer index
Browse files Browse the repository at this point in the history
  • Loading branch information
lgrcia committed Feb 14, 2024
1 parent d3f812c commit a21dac5
Show file tree
Hide file tree
Showing 4 changed files with 561 additions and 29 deletions.
4 changes: 3 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,9 @@
html_theme_options = {
"repository_url": "https://github.com/lgrcia/nuance",
"use_repository_button": True,
# "show_navbar_depth": 2,
"use_edit_page_button": True,
"use_issues_button": True,
"default_mode": "light",
}

nb_render_image_options = {"align": "center"}
Expand Down
48 changes: 45 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,59 @@ Efficient detection of planets transiting active stars
:height: 200px
:align: center
```
<div style="margin: 100px"></div>
<div style="margin: 50px"></div>


````{grid} 3
---
padding: 0
margin: 0
gutter: 0
---
```{grid-item-card} 🐤 Where to start?
---
class-card: sd-border-0
shadow: None
---
Read the [Motivation](./notebooks/motivation.ipynb) behind the development of *nuance* and
check out the basic transit search [Examples](./examples).
```
```{grid-item-card} 📦 Applications
---
class-card: sd-border-0
shadow: None
---
Explore the applications of nuance on realistic datasets, such
as [TESS](./notebooks/tutorials/tess_search) or [Ground-based](./notebooks/tutorials/ground_based) observations.
```
```{grid-item-card} ⚙️ More details
---
class-card: sd-border-0
shadow: None
---
Read the [*nuance* paper](https://arxiv.org/abs/2402.06835), learn [How the package works]() or study the
[API](./markdown/API.md).
```
````

*nuance* uses linear models and gaussian processes (using [JAX](https://github.com/google/jax)-based [tinygp](https://github.com/dfm/tinygp)) to simultaneously **search for planetary transits while modeling correlated noises** (e.g. stellar variability) in a tractable way.

Paper released [on arxiv](https://arxiv.org/abs/2402.06835).

---

```{toctree}
:maxdepth: 1
:caption: Get started
markdown/install
notebooks/motivation.ipynb
notebooks/star.ipynb
notebooks/templates.ipynb
examples.md
Expand All @@ -40,6 +82,6 @@ notebooks/tutorials/exocomet.ipynb
:maxdepth: 1
:caption: Reference
markdown/how
markdown/how.ipynb
markdown/API
```
499 changes: 499 additions & 0 deletions docs/notebooks/motivation.ipynb

Large diffs are not rendered by default.

39 changes: 14 additions & 25 deletions docs/notebooks/templates.ipynb

Large diffs are not rendered by default.

0 comments on commit a21dac5

Please sign in to comment.