README
¶
Kit
Common packages for GeoNet applications.
Protobuf Definitions
Protobuf definitions are stored in the protobuf dir. Go pkgs are generated from these files
with a _pb suffix e.g., haz_pb is generated from protobuf/haz. Go protobuf pkgs import
google.golang.org/protobuf/proto this is not vendored here. Pkgs are tested against the latest
version of google.golang.org/protobuf/proto.
(06/Aug/2021) Currently github.com/golang/groupcache is still using github.com/golang/protobuf thus an indirect still in go.mod. Need to keep watching if groupcache has migrated so we can get rid of this.
Go Packages
gloria_pb
a generated pkg for gloria protobuf messages.
haz_pb
a generated pkg for haz protobuf messages.
metrics
metrics is for gathering metrics.
mmi
mmi is for Modificed Mercalli Intensity calculations in New Zealand.
sc3ml
sc3ml is for working with SeisComPML files.
seis
seis/msis for working with miniSEED data.seis/slis for working with SEEDlink servers.seis/dlis for working with datalink servers.
shake
shake is for PGA, PGV, and MMI calculations
weft
weft helps with web applications.
wgs84
wgs84 is for distance, bearing, and locality calculations on the WGS84 ellipsoid.
cfg
cfg helps read Postgres configuration from env var.
Directories
¶
| Path | Synopsis |
|---|---|
|
aws
|
|
|
keyspaces
Package keyspaces is for working with AWS Keyspaces (for Apache Cassandra).
|
Package keyspaces is for working with AWS Keyspaces (for Apache Cassandra). |
|
s3
Package s3 is for working with AWS S3 buckets.
|
Package s3 is for working with AWS S3 buckets. |
|
sns
Package sns is for messaging with AWS SNS.
|
Package sns is for messaging with AWS SNS. |
|
sqs
Package sqs is for messaging with AWS SQS.
|
Package sqs is for messaging with AWS SQS. |
|
Package cfg is for reading config from environment variables.
|
Package cfg is for reading config from environment variables. |
|
gloria_pb is generated from the protobuf specification at https://github.com/GeoNet/delta/tree/master/protobuf/gloria With delta checked out it can be generated using protoc --proto_path=../delta/protobuf/gloria --go_out=internal/gloria_pb ../delta/protobuf/gloria/gloria.proto
|
gloria_pb is generated from the protobuf specification at https://github.com/GeoNet/delta/tree/master/protobuf/gloria With delta checked out it can be generated using protoc --proto_path=../delta/protobuf/gloria --go_out=internal/gloria_pb ../delta/protobuf/gloria/gloria.proto |
|
map180 draws SVG maps on EPSG3857.
|
map180 draws SVG maps on EPSG3857. |
|
nzmap
Package nzmap is for drawing large scale context maps in SVG format of the New Zealand region.
|
Package nzmap is for drawing large scale context maps in SVG format of the New Zealand region. |
|
pkg metrics is for gathering metrics.
|
pkg metrics is for gathering metrics. |
|
Package mmi is for Modificed Mercalli Intensity calculations in New Zealand.
|
Package mmi is for Modificed Mercalli Intensity calculations in New Zealand. |
|
Package sc3ml is for parsing SeisComPML.
|
Package sc3ml is for parsing SeisComPML. |
|
seis
|
|
|
dl
The dl module has been writen as a lightweight replacement for the C libdali library.
|
The dl module has been writen as a lightweight replacement for the C libdali library. |
|
ms
The ms module has been writen as a lightweight replacement for some parts of the libmseed C library.
|
The ms module has been writen as a lightweight replacement for some parts of the libmseed C library. |
|
sl
The sl module has been writen as a lightweight replacement for the C libslink library.
|
The sl module has been writen as a lightweight replacement for the C libslink library. |
|
ui
|
|
|
weft helps with web applications.
|
weft helps with web applications. |
|
Package wgs84 is for distance, bearing, and locality calculations on the WGS84 ellipsoid.
|
Package wgs84 is for distance, bearing, and locality calculations on the WGS84 ellipsoid. |