Skip to content

Latest commit

 

History

History
127 lines (106 loc) · 5.53 KB

readme.md

File metadata and controls

127 lines (106 loc) · 5.53 KB
Raw

Notes Regarding Installation

Date: 2022.02.22

This repository was originally forked from https://github.com/AIT-WATCHMAN/WMUtils in Feb 2022. We will keep this repo public until people request privacy. The watchmanInstaller.sh will download a fresh copy of cmake, python, geant4, ratpac, ... and build them from scratch. A complete installation using this script will result a total of 10-20 GB WMUtils directory, including all ratpac dependence and more. Some are useful for WbLS, some are not.

  • Workstation. watchmanInstaller.sh works on Linux. I have not tested it on MacOS. You do not need to do the compeleted installtion for ratpac. For example, the following will only install five packages (2-3 GB) upto ratpac:
. watchmanInstaller.sh --only cmake python root geant4 ratpac -j8

where -j8 just means compiling with 8 cores in parallel (much faster). It also helps to compile the packages one by one when seeing a lot of error messages. But it needs to be done in the order listed above:

. watchmanInstaller.sh --only cmake -j8
# repeat above for python, root, geant4, ratpac

Note, the ratpac is pulled from our https://github.com/BNLIF/rat-pac repository into the WMUtils/ratpac directory, but whatever happened inside WMUtils/ratpac is ignored by git when commiting to WMUtils repository. Individual code development happens in ratpac WMUtils/directory. When we commit the changes to ratpac, it should get pushed to https://github.com/BNLIF/rat-pac.

  • SDCC. We can have multiple installations on the same machine (ex. dune0001.sdcc.bnl.gov) if the storage is small. Please use --only options as shown above to only install package upto ratpac. This way, we each will only occupy 2-3GB of space. There is one shared group directory at /gpfs01/lbne/users/wbls for data sharing.

The watchmanInstaller.sh generate a env.sh after the installation. Source it and you can now use ratpac.

. env.sh

Trouble Shooting

Typically if a dependent package is missing, sudo apt-get install will solve the problem. In the absence of sudo permission (ex. SDCC):

  • change libOpenGL -> libGL if libOpenGL.so is missing on sdcc (see libraries=(libX11 libXpm libXft libffi libXext libQt libOpenGL) in watchmanInstaller.sh

Watchman Utilities

Maintainer: @MorganAskins

This repository is an organized dumping ground for watchman related code which should include useful tools (such as watchmakers and sibyl), related analysis scripts, macro files, and anything else that does not belong directly in rat-pac.

watchmanInstaller.sh

The watchman installer script is designed to help with the installation of various components of the watchman software suite. It is not designed to be completely fool-proof or work on every system. Compatibility seems to be best with various newer versions of linux. Each piece of the package can either be installed separately or all together; for a first time through I would recommend installing and testing each piece in order.

To run:

./watchmanInstaller.sh

To skip individual components, or target specific components use

./watchmanInstaller.sh --skip $X
## OR
./watchmanInstaller.sh --only $X

── $X ∈ (cmake, python, root, geant, ratpac, sibyl)

The installer will check if particular libraries are already available on the system before running. If they are not it is recommended to go install them through your system's package manager. If the check fails but you want to attempt to install everything anyways, then you can skip the checks

./watchmanInstaller.sh --skip-checks

Finally, multi-thread the compilation, you can pass through the number of processors for cmake to use

./watchmanInstaller.sh -jN

Once complete, everything should be installed locally and a file env.sh will be created---source this to setup the working environment.

Example: Ubuntu 20.04

sudo apt-get -q update
sudo apt-get install git curl build-essential libx11-dev libxpm-dev \
  libqt5opengl5-dev xserver-xorg-video-intel libxft-dev libxext-dev \
  libxkbcommon-x11-dev libopengl-dev libcurl4-gnutls-dev gfortran \
  ca-certificates libssl-dev libffi-dev

./watchmanInstaller.sh

Using your own ratpac

You can work in this directory and everything that starts with ratpac or rat-pac is already in the .gitignore. To pull in your own version of rat-pac for development the following is recommended (assuming ssh key). Another recommendation would be to keep every development branch in its own folder.

git clone [email protected]:Username/rat-pac.git ratpac_development
cd ratpac_development
# Add ait-watchman as a remote and update your master branch accordingly
git remote add upstream [email protected]:AIT-Watchman/rat-pac.git
git fetch upstream
git merge upstream/master
git push origin master

Development should occur on your repository on an aptly named branch. A good choice would be to give the branch the same name as the folder it is being developed in.

git checkout -b development
# Make changes to the code
git add changed_files
git commit -m
git push origin development

Finally if you are reviewing another user's pull request, you can directly fetch the pull request by number. E.g. if I want to checkout pull-request #1234:

git clone [email protected]:ait-watchman/rat-pac.git ratpac_devpr
cd ratpac_devpr
git fetch origin +refs/pull/1234/merge
git checkout FETCH_HEAD