Git for STAR users

This collection of tools is provided to the users of the STAR experiment with the hope to help them overcome difficulties caused by the migration of the codebase to Git.

Installing star-git-tools

Install star-git-tools from network with a single command:

curl -sSL https://bit.ly/star-git-tools | PREFIX=$HOME/some/path bash /dev/stdin

or install from source by cloning its GitHub repo and then running make install in the cloned directory.

$ git clone https://github.com/star-bnl/star-git-tools.git
$ cd star-git-tools
$ [sudo] make install

By default, star-git-tools is installed under /usr/local. To install it at an alternate location, specify a PREFIX when calling make. Then make sure PREFIX/bin is in the PATH.

# Non-root users can install under their home directory
make install PREFIX=$HOME/some/path

# For third-party software kept under /opt/star
make install PREFIX=/opt/star

# Add `PREFIX/bin` to the `PATH`. E.g. bash users can add to their ~/.bashrc file
export PATH+=":$HOME/some/path/bin"

Commands

A basic usage and examples

git-star-checkout

Do a partial clone followed by a sparse checkout of specified directories. Requires Git version >= 2.26.2

$ git star-checkout StRoot/StPicoEvent StRoot/StMuDSTMaker

Acknowledgments

The following projects provided a good deal of inspiration:

• https://github.com/cms-sw/cms-git-tools
• https://github.com/tj/git-extras