Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Simplify Greyhound installation/configuration via NPM (#31)
- Loading branch information
1 parent
5d9c6a4
commit d783f47
Showing
79 changed files
with
246 additions
and
39,361 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
examples/* | ||
*node_modules* | ||
controller/build/* | ||
data/* | ||
build/* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,8 @@ | ||
*.o | ||
.DS_Store | ||
pdal-session/pdal-session | ||
examples/cpp/get-points | ||
examples/cpp/put-pipeline | ||
*.log | ||
*.swp | ||
*.rdb | ||
|
||
key.pem | ||
cert.pem | ||
config.json | ||
credentials.js | ||
node_modules | ||
*node_modules* | ||
npm-debug.log | ||
.vagrant | ||
doc/*.pdf | ||
web/public/css/style.css | ||
scripts/vagrant/pdal | ||
scripts/vagrant/entwine | ||
controller/build | ||
src/build/* | ||
*.gypi | ||
|
||
examples/data/* | ||
!examples/data/autzen.las | ||
!examples/data/half-dome.laz | ||
!examples/data/read.xml | ||
!examples/data/half-dome.xml | ||
data/* | ||
!data/autzen.las |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
data/* | ||
build/* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,51 @@ | ||
# Greyhound | ||
# GREYHOUND | ||
|
||
A point cloud querying and streaming framework over HTTP for the web and your native apps. | ||
A point cloud streaming framework for dynamic web services and native applications. | ||
|
||
# Tell me more | ||
_Greyhound_ is powered by [Entwine](https://entwine.io/) which is used to organize | ||
data in a form that Greyhound can then emit to clients. Entwine uses [PDAL](http://pdal.io) | ||
for data access and abstraction to a wide variety of formats. See the [client | ||
documentation](https://github.com/hobu/greyhound/blob/master/doc/clientDevelopment.rst) | ||
and the [administrator | ||
documentation](https://github.com/hobu/greyhound/blob/master/doc/administration.rst) | ||
for more details on development and deployment. | ||
See it in action with the dynamic [Plas.io](http://speck.ly) client at [speck.ly](http://speck.ly) and the [Potree](http://potree.org) client at [potree.entwine.io](http://potree.entwine.io). | ||
|
||
A simple | ||
[RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) HTTP | ||
protocol is used to query and stream points in a format specified by the | ||
client. | ||
# Getting started | ||
|
||
# How to hack? | ||
## Obtaining Greyhound | ||
|
||
For now, see the usage instructions in the [entwine repository](https://entwine.io). | ||
### Using Docker | ||
```bash | ||
docker pull connormanning/greyhound | ||
docker run -it -p 8080:8080 connormanning/greyhound | ||
``` | ||
|
||
# License | ||
_Greyhound_ is under **MIT** license and is Copyright [Howard | ||
Butler](http://hobu.co), [Uday Verma](https://github.com/verma), and [Connor | ||
Manning](https://github.com/connormanning). | ||
### Natively | ||
|
||
Prior to installing natively, you must first install [PDAL](https://pdal.io) and its dependencies, and then install [Entwine](https://entwine.io). Then you can install Greyhound via NPM. | ||
|
||
```bash | ||
npm install -g greyhound-server | ||
greyhound | ||
``` | ||
|
||
## Indexing some data | ||
|
||
Greyhound uses data indexed by [Entwine](https://entwine.io/). See [the instructions](https://github.com/connormanning/entwine) for how to use Entwine. By default, Greyhound will look for indexed data in `~/greyhound` (natively) and `/opt/data` (dockerized). If you are eager to get started, we have some publicly hosted data you can index and serve locally: | ||
|
||
```bash | ||
docker pull connormanning/entwine | ||
mkdir ~/greyhound | ||
docker run -it -v ~/greyhound:/opt/data connormanning/entwine \ | ||
entwine build \ | ||
-i https://entwine.io/sample-data/red-rocks.laz \ | ||
-o /opt/data/red-rocks | ||
``` | ||
|
||
## Viewing the data | ||
|
||
You've just indexed a LAZ file from the internet (data credit to [DroneMapper](https://dronemapper.com/sample_data)) and created a local Entwine dataset. It's sitting at `~/greyhound/red-rocks`. Now let's start Greyhound and take a look at the data. We'll be mapping that output directory into Greyhound's default search path at `/opt/data` within the container: | ||
|
||
```bash | ||
docker run -it -p 8080:8080 -v ~/greyhound:/opt/data connormanning/greyhound | ||
``` | ||
|
||
Now that Greyhound is awake, you should be able to browse your data with [Plasio](http://speck.ly/?s=http://localhost:8080/&r=red-rocks) or [Potree](http://potree.entwine.io/data/custom.html?s=localhost:8080&r=red-rocks). | ||
|
||
# Further reading | ||
See the [client documentation](https://github.com/hobu/greyhound/blob/master/doc/clientDevelopment.rst) if you are interested in developing an application that streams data from Greyhound. For instructions regarding configuring and deploying Greyhound, see the [administrator documentation](https://github.com/hobu/greyhound/blob/master/doc/administration.rst). | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.