Skip to content

Commit

Permalink
Merge pull request #11 from astronomy-commons/delucchi/readme
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
delucchi-cmu authored Mar 23, 2023
2 parents 9b85ab6 + 0e27611 commit 7f72881
Showing 1 changed file with 33 additions and 2 deletions.
35 changes: 33 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,33 @@
# lsdb
Large Survey DataBase
<img src="https://www.lsstcorporation.org/lincc/sites/default/files/PastedGraphic-8.png" width="300" height="100">
<img src="https://user-images.githubusercontent.com/113376043/211332292-4705c34c-5e74-4f12-85e2-be4bacaa8700.jpg" width="300">

# LSDB

[![Template](https://img.shields.io/badge/Template-LINCC%20Frameworks%20Python%20Project%20Template-brightgreen)](https://lincc-ppt.readthedocs.io/en/latest/)

![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/astronomy-commons/lsdb)
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/astronomy-commons/lsdb/testing-and-coverage.yml)
![Read the Docs](https://img.shields.io/readthedocs/lsdb)

## LSDB - Large Survey DataBase

A framework to facilitate and enable spatial analysis for extremely large astronomical databases
(i.e. querying and crossmatching O(1B) sources). This package uses dask to parallelize operations across
multiple HiPSCat partitioned surveys.

Check out our [ReadTheDocs site](https://lsdb.readthedocs.io/en/latest/)
for more information on partitioning, installation, and contributing.

See related projects:

* HiPSCat ([on GitHub](https://github.com/astronomy-commons/hipscat))
([on ReadTheDocs](https://hipscat.readthedocs.io/en/latest/))
* HiPSCat Import ([on GitHub](https://github.com/astronomy-commons/hipscat-import))
([on ReadTheDocs](https://hipscat-import.readthedocs.io/en/latest/))

## Contributing

[![GitHub issue custom search in repo](https://img.shields.io/github/issues-search/astronomy-commons/lsdb?color=purple&label=Good%20first%20issues&query=is%3Aopen%20label%3A%22good%20first%20issue%22)](https://github.com/astronomy-commons/lsdb/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)

See the [contribution guide](https://lsdb.readthedocs.io/en/latest/overview/contributing.html)
for complete installation instructions and contribution best practices.

0 comments on commit 7f72881

Please sign in to comment.