Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/go-spatial/geocatalogo
Geospatial Catalogue in Go
https://github.com/go-spatial/geocatalogo
Last synced: 18 days ago
JSON representation
Geospatial Catalogue in Go
- Host: GitHub
- URL: https://github.com/go-spatial/geocatalogo
- Owner: go-spatial
- License: mit
- Created: 2017-10-27T22:09:54.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-10-09T01:46:44.000Z (about 5 years ago)
- Last Synced: 2024-05-02T12:02:10.339Z (7 months ago)
- Language: Go
- Size: 168 KB
- Stars: 22
- Watchers: 7
- Forks: 5
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# geocatalogo
[](https://travis-ci.org/go-spatial/geocatalogo)
[](https://goreportcard.com/report/github.com/go-spatial/geocatalogo)
[](https://godoc.org/github.com/go-spatial/geocatalogo)
## Overview
Geospatial Catalogue in Go
## Installation
# Requirements
geocatalogo's default backend is [Elasticsearch](https://www.elastic.co/) and
requires an Elasticsearch endpoint as defined in configuration.
```bash
# create directory for local env
mkdir /path/to/golang-env
export GOPATH=/path/to/golang-env
# install dependencies
go get golang.org/x/text/encoding
go get github.com/sirupsen/logrus
go get gopkg.in/yaml.v2
go get gopkg.in/olivere/elastic.v6/..
go get golang.org/x/lint/...
# install geocatalogo
go get github.com/go-spatial/geocatalogo/...
cd $GOPATH/src/github.com/go-spatial/geocatalogo
# set configuration
# (sample in $GOPATH/src/github.com/go-spatial/geocatalogo/geocatalogo-config.env)
cp geocatalogo-config.env local.env
vi local.env # update accordingly
# GEOCATALOGO_SERVER_OPENAPI: path to OpenAPI Document
# GEOCATALOGO_SERVER_URL: URL of geocatalogo instance for serving via HTTP
# GEOCATALOGO_REPOSITORY_URL: URL to Elasticsearch
. local.env
```
## Running
### Using the geocatalogo command line utility
```bash
# list commands
geocatalogo
# index a metadata record
geocatalogo index --file=/path/to/record.xml
# index a directory of metadata records
geocatalogo index --dir=/path/to/dir
# dedicated importers
# Landsat on AWS (https://aws.amazon.com/public-datasets/landsat/)
curl http://landsat-pds.s3.amazonaws.com/c1/L8/scene_list.gz | gunzip > /tmp/scene_list
landsat-aws-importer --file /tmp/scene_list
# OpenAerialMap Catalog (https://docs.openaerialmap.org/catalog/)
curl "https://api.openaerialmap.org/meta?limit=5000" > /tmp/oam.json
oam-catalog-importer --file /tmp/scene_list
# search index
geocatalogo search --term=landsat
# search by bbox
geocatalogo search --bbox -152,42,-52,84
# search by time instant
geocatalogo search --time 2018-01-19T18:28:02Z
# search by time range
geocatalogo search --time 2007-11-11T12:43:29Z/2018-01-19T18:28:02Z
# search by collections
geocatalogo search --collections landsat8
# search by any combination exclusively (term, bbox, time)
geocatalogo search --time 2007-11-11T12:43:29Z/2018-01-19T18:28:02Z --bbox -152,42,-52,84 --term landsat
# get a metadata record by id
geocatalogo get --id=12345
# get a metadata record by list of ids
geocatalogo get --id=12345,67890
# run as an HTTP server (default port 8000)
geocatalogo serve
# run as an HTTP server on a custom port
geocatalogo serve --port 8001
# run as an HTTP server honouring the STAC API
geocatalogo serve --api stac
# get version
geocatalogo version
```
### Using the API
```go
// init a Geocatalogue from environment
import (
"encoding/json"
"fmt"
"github.com/go-spatial/geocatalogo"
"github.com/go-spatial/geocatalogo/metadata/parsers"
)
cat, err := geocatalogo.NewFromEnv()
if err != nil {
fmt.Println(err)
}
// index a Dublin Core metadata record
source, err := ioutil.ReadFile(file)
if err != nil {
fmt.Printf("Could not read file: %s\n", err)
}
metadataRecord, err := parsers.ParseCSWRecord(source)
if err != nil {
fmt.Printf("Could not parse metadata: %s\n", err)
continue
}
result := cat.Index(metadataRecord)
if !result {
fmt.Println("Error Indexing")
}
// search records and present records 0 - 10
results := cat.Search("birds", 0, 10)
// get record by id
results := cat.Get("record-id-123")
// process results
for _, result := range results.Records {
b, _ := json.MarshalIndent(result, "", " ")
fmt.Printf("%s\n", b)
}
```
## Development
### Running Tests
## Releasing
### Bugs and Issues
All bugs, enhancements and issues are managed on [GitHub](https://github.com/go-spatial/geocatalogo).
## Contact
* [Tom Kralidis](https://github.com/tomkralidis)