Skip to content

Commit

Permalink
updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Schwarzam committed May 16, 2024
1 parent a52a7f1 commit b7fb985
Show file tree
Hide file tree
Showing 3 changed files with 2,238 additions and 330 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,6 @@ Cargo.lock
**/*.rs.bk

# MSVC Windows builds of rustc generate these, which store debugging information
*.pdb
*.pdb

.DS_Store
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,17 @@ A lightweight, fast and easy to use server for the [lsdb server test branch](htt

---

#### TODO list:

- [ ] Accept lower case column names
- [ ] Get columns by index
- [ ] Exclude columns by name
- [ ] Fix `_hipscat_index` parquet schema

### Configuring the server

`lsdb-server` works with [lsdb server test branch](https://github.com/Schwarzam/lsdb/tree/server-test) if you have the hips partitioned catalogs in your server.

Generate the hips using [hipscat-import](https://lsdb.readthedocs.io/en/latest/tutorials/import_catalogs.html).

---
Expand Down Expand Up @@ -48,3 +57,4 @@ server {
```
---

Loading

0 comments on commit b7fb985

Please sign in to comment.