Skip to content

kbaseattic/Shock

 
 

Repository files navigation

Shock Mini container image

This branch has a makefile that builds a special small footprint container image for running Shock. It is not compatible with Dockerhub automated builds, and requires an actual CI environment that can execute a makefile properly

About

Shock is a platform to support computation, storage, and distribution. Designed from the ground up to be fast, scalable, fault tolerant, federated.

Shock is RESTful. Accessible from desktops, HPC systems, exotic hardware, the cloud and your smartphone.

Shock is for scientific data. One of the challenges of large volume scientific data is that without often complex metadata it is of little to no value. Shock allows storage and querying of complex metadata.

Shock is a data management system. The long term goals of Shock include the ability to annotate, anonymize, convert, filter, perform quality control, and statically subsample at line speed bioinformatics sequence data. Extensible plug-in architecture is in development.

Most importantly Shock is still very much in development. Be patient and contribute.

Shock is actively being developed at github.com/MG-RAST/Shock.

Building

Shock (requires mongodb=>2.0.3, go=>1.1.0 golang.org, git, mercurial and bazaar). You must also set the $GOPATH and $GOROOT environment variables before installing Shock. There are two options for installing Shock.

OPTION 1: The recommended method for installing Shock is to download the Makefile located here to your $GOPATH directory and then run:

make install

OPTION 2: You could alternatively install Shock by running:

go get github.com/MG-RAST/Shock/...

The upside to using OPTION 1 is that this will insert the Shock version number into your Shock server to be displayed when the server is started and this will also generate the Shock documentation locally to be hosted by the server. The built binaries will be located in the env configured $GOPATH/bin/ directory.

Configuration

The Shock configuration file is in INI file format. There is a template of the config file located at the root level of the repository.

Running

To run:

shock-server -conf <path_to_config_file>

Documentation

For further information about Shock's functionality, please refer to our github wiki.

About

An object store for scientific data

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 51.6%
  • Go 39.8%
  • Perl 4.3%
  • JavaScript 1.7%
  • Python 1.6%
  • Shell 0.5%
  • Other 0.5%