Skip to content

Latest commit

 

History

History
56 lines (34 loc) · 1.93 KB

README.md

File metadata and controls

56 lines (34 loc) · 1.93 KB
Raw

hpc-utility

CLI utility for the High Performance Computing (HPC) cluster.

Clone and build the code

To build the code, you will need the GO compiler.

Following the "GO concept", identify the $GOPATH on your system under which various GO source codes, libraries and binaries will be stored (and organized).

Assuming we use $HOME/projects/go as the $GOPATH, we will then clone the code of this repository as the follows:

$ export GOPATH=$HOME/projects/go
$ mkdir -p $GOPATH/src/github.com/Donders-Institute
$ cd $GOPATH/src/github.com/Donders-Institute
$ git clone https://github.com/Donders-Institute/hpc-utility.git
$ cd hpc-utility

We then build the code with the following command:

$ make

After the build, the binaries will be located under various subdirectories in the $GOPATH, for example, the executables are in $GOPATH/bin and library files are in $GOPATH/pkg.

One could also build RPM on a CentOS 7.x using the following command:

$ make release

or make a GitHub release with the RPM as the release asset:

$ VERSION={RELEASE_NUMBER} make github_release

where the {RELEASE_NUMBER} is the new release number to be created on this repository's release page. It cannot be an existing release number.

Usage

The usage document can be found here.

Contribute to the code

Folder structure of the repository

The repository holds a GO project. The folders are organized according to the GO standard. The rationale of this style of organization is explained in this post.

The Makefile

The Makefile is created to simplify the build process. In it, we make use of the go dep to manage the library dependancies.