Home - WCSim/WCSim GitHub Wiki

Introduction

WCSim is a very flexible GEANT4 based program for developing and simulating large water Cherenkov detectors. WCSim has very few external dependencies. It relies on only ROOT and Geant4. For build instructions etc see the README file.

GitHub Info

This version of WCSim has been moved to GitHub. You should make new features by making a feature branch off of develop and then ask for a pull request.

The repository contains the following branches:

  • master: This is only for official releases. Do not put development here.

  • development: This is the development branch. Feature branches start here.

  • feature: These are branches where you work on new features.

  • archive: These are old historical work branches from the WCSim Duke SVN repository.

Releases will be tags on the master branch.

For more details, we are using the git-flow development model. You can read about it here:

http://nvie.com/posts/a-successful-git-branching-model/

If you are using a Mac I can recommend using the graphical browser sourcetree which understands this model and can lead you through the steps of preparing your repository for git-flow, adding a feature or making a release etc. There are other tools avaliable to do this also.

http://blog.sourcetreeapp.com/2012/08/01/smart-branching-with-sourcetree-and-git-flow/

This explains the model more and as an example shows how to use sourcetree with it. This can also all be done on the command line.

Tutorials and help documents

Tutorials highlighting the basic features of WCSim are available. Tutorial topics are how to set up GitHub for WCSim , how to add your own photosensor, and how to make your own detector. A help documents on how to keep your branches up to date and how to manage your branches and make a pull request are also available.

Documentation of the nuance format used in the primary generator action can be found here.