Skip to content

Commit

Permalink
readme: add badges, tweak docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lgarrison committed Mar 7, 2024
1 parent 50378e4 commit 7ddd054
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# nifty-ls
A fast Lomb-Scargle periodogram. It's nifty, and uses a NUFFT!

[![PyPI](https://img.shields.io/pypi/v/nifty-ls)](https://pypi.org/project/nifty-ls/) [![Tests](https://github.com/flatironinstitute/nifty-ls/actions/workflows/tests.yml/badge.svg)](https://github.com/flatironinstitute/nifty-ls/actions/workflows/tests.yml) [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/flatironinstitute/nifty-ls/main.svg)](https://results.pre-commit.ci/latest/github/flatironinstitute/nifty-ls/main)

> [!WARNING]
> This project is in a pre-release stage and will likely undergo breaking changes during development. Some of the instructions in the README are aspirational.
Expand All @@ -20,20 +22,20 @@ with default settings for many regions of parameter space.
For CPU support:

```console
$ pip install niftyls
$ pip install nifty-ls
```

For GPU (CUDA) support:

```console
$ pip install niftyls[cuda]
$ pip install nifty-ls[cuda]
```


### From source
First, clone the repo:
```console
$ git clone https://www.github.com/flatironinstitute/niftyls
$ git clone https://www.github.com/flatironinstitute/nifty-ls
```

To install with CPU support:
Expand Down

0 comments on commit 7ddd054

Please sign in to comment.