source/coresoftware/README.md

0001
0002 # Welcome
0003
0004 This is the core-software respository for [sPHENIX collaboration](https://www.sphenix.bnl.gov/).
0005
0006 [![Build Status](https://web.sdcc.bnl.gov/jenkins-sphenix/buildStatus/icon?job=sPHENIX/sPHENIX_CoreSoftware_MasterBranch)](https://web.sdcc.bnl.gov/jenkins-sphenix/job/sPHENIX/job/sPHENIX_CoreSoftware_MasterBranch/)
0007 [![Doxygen](https://img.shields.io/badge/code%20reference-Doxygen-green.svg)](https://sphenix-collaboration.github.io/doxygen/)
0008 [![Singularity](https://img.shields.io/badge/container-Singularity%20via%20CVMFS-green.svg)](https://github.com/sPHENIX-Collaboration/Singularity)
0009
0010 [![Open Issues](https://img.shields.io/github/issues/sPHENIX-Collaboration/coresoftware.svg)](https://github.com/sPHENIX-Collaboration/coresoftware/issues)
0011 [![Open Pull Request](https://img.shields.io/github/issues-pr/sPHENIX-Collaboration/coresoftware.svg)](https://github.com/sPHENIX-Collaboration/coresoftware/pulls)
0012 [![Monthly Commits](https://img.shields.io/github/commit-activity/m/sPHENIX-Collaboration/coresoftware.svg)](https://github.com/sPHENIX-Collaboration/coresoftware/commits/master)
0013 [![Last Commit](https://img.shields.io/github/last-commit/sPHENIX-Collaboration/coresoftware.svg)](https://github.com/sPHENIX-Collaboration/coresoftware/commits/master)
0014 [![Download size](https://img.shields.io/github/languages/code-size/sPHENIX-Collaboration/coresoftware.svg)](https://github.com/sPHENIX-Collaboration/coresoftware/archive/master.zip)
0015
0016 Code from the `master` branch is pulled and build each night (nightly-build)
0017 and it becomes [part of the default software environment on RCF](https://wiki.bnl.gov/sPHENIX/index.php/Setup#.28At_each_login.29_Run_sPHENIX_login_shell).
0018 Weekly snapshot of the build is also available as ANA-builds.
0019
0020 Due to its importance, update of this repository require going through a review via [the "Pull Request" process](https://wiki.bnl.gov/sPHENIX/index.php/GitHub_Coresoftware_Update_Procedures). New pull requests will be automatically checked with the [sPHENIX Jenkins continuous integration](https://web.sdcc.bnl.gov/jenkins-sphenix/). At the end of the check, a report will be posted back to the corresponding pull request thread.
0021
0022 # Useful links
0023
0024 * Tutorials
0025   * [Get started on day-1](https://wiki.bnl.gov/sPHENIX/index.php/SPHENIX_software_day-1_checklist)
0026   * [sPHENIX macros that run this core-software](https://github.com/sPHENIX-Collaboration/macros)
0027   * [Tutorial for sample code on simulation](https://github.com/sPHENIX-Collaboration/tutorials)
0028   * [Run sPHENIX software anywhere with container](https://github.com/sPHENIX-Collaboration/Singularity)
0029   * ["Pull Request" tutorial to update this repository](https://wiki.bnl.gov/sPHENIX/index.php/GitHub_Coresoftware_Update_Procedures)
0030 * Documentation
0031   * [Software wiki](https://wiki.bnl.gov/sPHENIX/index.php/Software)
0032   * [Doxygen: easier way to browse code](https://sphenix-collaboration.github.io/doxygen/)
0033   * [Build a package](https://wiki.bnl.gov/sPHENIX/index.php/Example_of_using_DST_nodes#Building%20a%20package)
0034   * [Coding convention](https://wiki.bnl.gov/sPHENIX/index.php/Codingconventions#Coding_Convention)
0035 * Communication
0036   * [Simulation and software meeting series](https://indico.bnl.gov/categoryDisplay.py?categId=88)
0037   * [Discussion on this repository](https://lists.bnl.gov/mailman/listinfo/sphenix-github-l)
0038
0039 ---
0040
0041 [![logo](https://raw.githubusercontent.com/sPHENIX-Collaboration/utilities/master/jenkins/material/sphenix-logo-white-bg-72p.png)](https://www.sphenix.bnl.gov/)