Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
emilyhunt authored Jun 12, 2024
1 parent f5f84da commit eb838cd
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,35 @@ pip install -e git+https://github.com/emilyhunt/ocelot[dev]
```

After installing development dependencies, you can also make and view edits to the package's documentation. To view a local copy of the documentation, do `mkdocs serve`. You can do a test build with `mkdocs build`.


## Citation

There is currently no paper associated with `ocelot`. For now, please at least mention the package and add a footnote to your mention, linking to this repository - in LaTeX, that would be:

```
\footnote{\url{https://github.com/emilyhunt/ocelot}}
```


For now, you can also cite [Hunt & Reffert 2021](https://ui.adsabs.harvard.edu/abs/2021A%26A...646A.104H/abstract), which was the paper for which development of this module began:

```
@ARTICLE{2021A&A...646A.104H,
author = {{Hunt}, Emily L. and {Reffert}, Sabine},
title = "{Improving the open cluster census. I. Comparison of clustering algorithms applied to Gaia DR2 data}",
journal = {\aap},
keywords = {methods: data analysis, open clusters and associations: general, astrometry, Astrophysics - Astrophysics of Galaxies, Astrophysics - Solar and Stellar Astrophysics},
year = 2021,
month = feb,
volume = {646},
eid = {A104},
pages = {A104},
doi = {10.1051/0004-6361/202039341},
archivePrefix = {arXiv},
eprint = {2012.04267},
primaryClass = {astro-ph.GA},
adsurl = {https://ui.adsabs.harvard.edu/abs/2021A&A...646A.104H},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
```

0 comments on commit eb838cd

Please sign in to comment.