Skip to content

Commit f5c0998

Browse files
authored
Update README.md - add installation instructions, expand code snippets for each brief feature overview
1 parent 35c0a51 commit f5c0998

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

README.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,37 @@
1212

1313
Suite of utilities for interacting with Rubin LSST data within LSDB.
1414

15-
## LSST tract/patch search
15+
## Quickstart
16+
To install, clone the repository (ideally, within a virtual environment):
17+
```python
18+
git clone https://github.com/astronomy-commons/lsdb-rubin.git
19+
cd lsdb-rubin
20+
pip install .
21+
```
22+
23+
### LSST tract/patch search
1624
Use LSDB to search catalogs by LSST tract and/or patch.
1725
```python
26+
import lsdb
27+
from lsdb_rubin import tract_patch_search
28+
29+
lsdb.catalog.Catalog.tract_patch_search = tract_patch_search
30+
gaia = lsdb.read_hats("https://data.lsdb.io/hats/gaia_dr3/gaia")
31+
1832
gaia.tract_patch_search(skymap=lsst_skymap, tract=tract_index)
1933
```
20-
See the [demo notebook](https://github.com/astronomy-commons/lsdb-rubin/blob/main/docs/notebooks/tract_patch_search.ipynb).
34+
See the [demo notebook](https://github.com/astronomy-commons/lsdb-rubin/blob/main/docs/notebooks/tract_patch_search.ipynb) for more.
2135

22-
## Plot a LSST light curve
36+
### Plot a LSST light curve
2337
LSST light curves can be tricky to plot, so we've provided an easy method for a single light curve.
2438

2539
```python
40+
import lsdb
41+
from lsdb_rubin.plot_light_curve import plot_light_curve
42+
43+
dia_object = lsdb.open_catalog("../../tests/data/mock_dp1_1000")
44+
dia_object = dia_object.compute()
45+
2646
plot_light_curve(dia_object.iloc[0]["diaObjectForcedSource"])
2747
```
28-
See the [demo notebook](https://github.com/astronomy-commons/lsdb-rubin/blob/main/docs/notebooks/plot_light_curves.ipynb).
48+
See the [demo notebook](https://github.com/astronomy-commons/lsdb-rubin/blob/main/docs/notebooks/plot_light_curves.ipynb) for more.

0 commit comments

Comments
 (0)