Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: prepare readme for release #17

Merged
merged 3 commits into from
Dec 20, 2023
Merged

docs: prepare readme for release #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
952a9fe
:memo: Minor tweaks to `readme.md`
brackham Dec 19, 2023
3beb61c
docs: update quick description + ben's change in index
lgrcia Dec 20, 2023
ec04a7b
Merge branch 'docs-prepare-readme' of https://github.com/lgrcia/spott…
lgrcia Dec 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/source/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

**Note**

In its beta version, *spotter* is mainly developed to estimate transmission spectra stellar contamination from stellar rotational light curves.
In its beta version, *spotter* is mainly developed to estimate transmission spectra stellar contamination from stellar rotational light curves. Use at your own risk as the code is completely untested and its API subject to change.

## Features

Expand All @@ -19,7 +19,6 @@ In its beta version, *spotter* is mainly developed to estimate transmission spec
- GPU compatible <span style="color:grey">- *in beta*</span>
- Possibility to input any stellar spectra model


```{toctree}
:maxdepth: 1
:caption: Get started
Expand Down
10 changes: 5 additions & 5 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
</p>

<p align="center">
Forward models of non-uniform stars spectra
Forward models of non-uniform stellar photospheres and their spectra
<br>
<p align="center">
<a href="https://github.com/lgrcia/spotter">
Expand All @@ -18,7 +18,7 @@
</p>
</p>

*spotter* is a Python package to produce forward models of non-uniform stars spectra. It uses the [HEALPix](https://healpix.sourceforge.io/) subdivision scheme and is powered by the high-performance numerical package [JAX](https://jax.readthedocs.io/en/latest/notebooks/quickstart.html), enabling its use on GPUs.
*spotter* is a Python package to produce forward models of non-uniform stellar photospheres and their spectra. It uses the [HEALPix](https://healpix.sourceforge.io/) subdivision scheme and is powered by the high-performance numerical package [JAX](https://jax.readthedocs.io/en/latest/notebooks/quickstart.html), enabling its use on GPUs.

**Note**

Expand All @@ -27,8 +27,8 @@ In its beta version, *spotter* is mainly developed to estimate transmission spec
## Features

- Adjustable surface resolution <span style="color:grey">- *in beta*</span>
- Small-scale surface features modeling (e.g. beyond limitations of [starry]()) <span style="color:grey">- *in beta*</span>
- Modeling of any active regions with their limb laws (e.g. limb-brightened faculae)
- Small-scale surface feature modeling (e.g., beyond limitations of [starry]()) <span style="color:grey">- *in beta*</span>
- Modeling of active regions with unique angular dependence on brightness (e.g., limb-brightened faculae)
- GPU compatible <span style="color:grey">- *in beta*</span>
- Possibility to input any stellar spectra model

Expand All @@ -44,4 +44,4 @@ pip install -e spotter
with *spotter* cloned using
```
git clone https://github.com/lgrcia/spotter
```
```
Loading