kit

module

v0.0.0-...-2b5b0d2 Latest Latest Go to latest Published: Jul 15, 2019 License: MIT

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bpeng/kit

Links

Open Source Insights

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 github.com/golang/protobuf/proto this is not vendored here. Pkgs are tested against the latest version of github.com/golang/protobuf/proto.

Go Packages

gloria_pb

a generated pkg for gloria protobuf messages.

sit_pb

a generated pkg for protobufs created from the SIT repo.

sit_delta_pb

a generated pkg for protobufs created from the Delta repo for SIT.

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.

mseed

mseed is a Go wrapper for libmseed. It is for working with miniSEED data. If using mseed then libmseed will need to be explicitly vendored and compiled This will require a C compiler (eg., gcc) and make (possibly other packages depending on your system). Alpine requires musl-dev

govendor add github.com/GeoNet/kit/cvendor/libmseed/^
cd vendor/github.com/GeoNet/kit/cvendor/libmseed
make clean 
make

sc3ml

sc3ml is for working with SeisComPML files.

shake

shake is for PGA, PGV, and MMI calculations

slink

slink is a Go wrapper for libslink. It is for working with SEEDlink servers. If using slink then libslink will need to be explicitly vendored and compiled This will require a C compiler (eg., gcc) and make (possibly other packages depending on your system). Alpine requires musl-dev

govendor add github.com/GeoNet/kit/cvendor/libslink/^
cd vendor/github.com/GeoNet/kit/cvendor/libslink
make clean 
make

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 ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
cfg Package cfg is for reading config from environment variables.	Package cfg is for reading config from environment variables.
datalogger_pb Package datalogger_pb is a generated protocol buffer package.	Package datalogger_pb is a generated protocol buffer package.
fmp_pb Package fmp_pb is a generated protocol buffer package.	Package fmp_pb is a generated protocol buffer package.
gloria_pb 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 Package gloria_pb is a generated protocol buffer package.	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 Package gloria_pb is a generated protocol buffer package.
haz_pb Package haz_pb is a generated protocol buffer package.	Package haz_pb is a generated protocol buffer package.
map180 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.
metrics pkg metrics is for gathering metrics.	pkg metrics is for gathering metrics.
mmi Package mmi is for Modificed Mercalli Intensity calculations in New Zealand.	Package mmi is for Modificed Mercalli Intensity calculations in New Zealand.
mseed nolint //cgo generates code that doesn't pass linting nolint //cgo generates code that doesn't pass linting nolint //cgo generates code that doesn't pass linting	nolint //cgo generates code that doesn't pass linting nolint //cgo generates code that doesn't pass linting nolint //cgo generates code that doesn't pass linting
sc3ml Package sc3ml is for parsing SeisComPML.	Package sc3ml is for parsing SeisComPML.
shake
sit_delta_pb Package sit_delta_pb is a generated protocol buffer package.	Package sit_delta_pb is a generated protocol buffer package.
sit_pb Package sit_pb is a generated protocol buffer package.	Package sit_pb is a generated protocol buffer package.
slink nolint //cgo generates code that doesn't pass linting Package slink provides a go wrapper for the libslink C library.	nolint //cgo generates code that doesn't pass linting Package slink provides a go wrapper for the libslink C library.
weft weft helps with web applications.	weft helps with web applications.
wefttest
wgs84 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.