frs

Software for simulations and data analysis of FRS/Super-FRS/R3B experiments at GSI/FAIR

https://github.com/r3brootgroup/frs

Science Score: 49.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.2%) to scientific vocabulary

Keywords

data-analysis frs hypernuclei nuclear-physics nuclear-reactions nustar r3b super-frs
Last synced: 4 months ago · JSON representation

Repository

Software for simulations and data analysis of FRS/Super-FRS/R3B experiments at GSI/FAIR

Basic Info
  • Host: GitHub
  • Owner: R3BRootGroup
  • License: lgpl-3.0
  • Language: C
  • Default Branch: dev
  • Homepage:
  • Size: 2.71 MB
Statistics
  • Stars: 2
  • Watchers: 2
  • Forks: 11
  • Open Issues: 0
  • Releases: 6
Topics
data-analysis frs hypernuclei nuclear-physics nuclear-reactions nustar r3b super-frs
Created over 7 years ago · Last pushed 11 months ago
Metadata Files
Readme License Authors Codemeta Zenodo

README.md

FRS-R3B Software license DOI

static analysis CI-CD

The FRS-R3B Framework

The FRS-R3B directory within R3BRoot contains the software for the FRS (Fragment Separator) detectors that are utilized in the FRS-R3B experiments. The FRS is a pivotal instrument for investigating nuclear reactions with relativistic radioactive beams, enabling high-precision studies of exotic nuclei and nuclear structure at the limits of stability. This software is built upon the FairRoot framework, which provides the tools necessary for both Monte Carlo simulations and data analysis of experimental results. The R3B experimental program is part of the broader nuclear physics research efforts at the FAIR (Facility for Antiproton and Ion Research), a cutting-edge international research facility that utilizes heavy-ion and antiproton beams to explore fundamental questions in nuclear physics, with a particular focus on the production and behavior of rare isotopes under extreme conditions. The FRS-R3B software package is a source distribution with recurring releases for macOS and Linux.

License

FRS is distributed under the terms of the GNU Lesser General Public Licence version 3 (GPLv3).

Discussion Forum

For the software-related user support you can post a new topic on our forum.

Release Information

Please see releases

Download


~~~bash git clone dev https://github.com/R3BRootGroup/frs.git cd frs ~~~

Step by Step Installation

Required Softwares

First, you will need to install FairSoft, FairRoot and R3BRoot. For more details:

  1. Install FairSoft

  2. Install FairRoot

  3. Install R3BRoot

Installation of UCESB

Checkout the most recent version of ucesb from the git repository: ~~~bash git clone http://fy.chalmers.se/~f96hajo/ucesb/ucesb.git ~~~ And also checkout the git repository with experiment unpackers: ~~~bash git clone https://github.com/jose-luis-rs/frsexp.git ~~~ Check that ~~~bash which root ~~~ points to your FAIRROOT installation directory!

Compile the empty ucesb unpacker using the same version of ROOT as you used for FAIRROOT. ~~~bash make empty/empty ~~~ After compilation finished, make sure that the file ~~~bash hbook/extdataclnt.o ~~~ exists. Set the environment variable UCESBDIR to the 'unpacker' directory, e.g. ~~~bash export UCESBDIR=/u/$USER/path/to/unpacker ~~~ Put this in your .bashrc to make it permanent. R3BRoot will look for ucesb at this location.

Compile then your experiment specific unpacker (also use the same ROOT version here). ~~~bash cd frsexp/nameofexperiment make -j8 ~~~

Installation of FRS as part of R3BRoot

~~~bash export SIMPATH=%PATHTOFAIRSOFT% export FAIRROOTPATH=%PATHTOFAIRROOT% git clone dev https://github.com/R3BRootGroup/R3BRoot.git cd R3BRoot git clone dev https://github.com/R3BRootGroup/macros.git git clone dev https://github.com/R3BRootGroup/frs.git cd .. mkdir build cd build cmake ../R3BRoot/ . config.sh make -j8 ~~~

Data Analysis


Data analysis is included inside the frs directory, where you can find the next subdirectories:

frsdata

This directory contains all the classes for the different data levels of the detectors: mapped, cal, hit and analysis.

frssource

This directory contains all the readers needed to analize the data obained from the FRS detectors.

frsdetectors

This directory contains all the classes for the mapping, calibration, and hit reconstructions of physical events as well as some classes for the analysis of the FRS experiments (S0 to S4). The identification from S0 to S8 is ongoing!

macros

This contains all the macros needed for the unpacking and analysis of data.

Generating Doxygen documentation

If the flage -DBUILDDOXYGENFRS=ON is set when calling cmake, the doxygen documentation will be generated when calling make. The generated html files can then be found in "build/doxygen/doc/html"

Doxygen documantation is also available online here

More Information

Owner

  • Name: R3BRoot Group
  • Login: R3BRootGroup
  • Kind: organization
  • Email: d.kresan@gsi.de
  • Location: GSI, Darmstadt, Germany

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "license": "https://spdx.org/licenses/GPL-3.0",
  "codeRepository": "https://github.com/R3BRootGroup/frs",
  "contIntegration": "https://github.com/R3BRootGroup/frs/actions",
  "dateCreated": "2018-08-05",
  "datePublished": "2018-08-05",
  "dateModified": "2024-12-08",
  "downloadUrl": "https://github.com/R3BRootGroup/frs/archive/refs/tags/dec24.tar.gz",
  "issueTracker": "https://github.com/R3BRootGroup/frs/issues",
  "name": "FRS-R3B Software",
  "softwareVersion": "dec24",
  "description": "Software for simulations and data analysis of FRS/Super-FRS/R3B experiments at GSI/FAIR",
  "readme": "https://github.com/R3BRootGroup/frs/blob/dev/README.md",
  "releaseNotes": "",
  "applicationCategory": "Nuclear physics",
  "developmentStatus": "active",
  "keywords": [
    "Geant4",
    "c-plus-plus",
    "cmake",
    "vmc",
    "modular",
    "Track reconstruction",
    "Simulation",
    "Data analysis",
    "Structure and dynamics of nuclei",
    "Nuclear reactions",
    "Nuclear fission"
  ],
  "programmingLanguage": [
    "C",
    "C++"
  ],
  "runtimePlatform": [
    "ROOT"
  ],
  "operatingSystem": [
    "Linux",
    "macOS"
  ],
  "softwareRequirements": [
    "FairRoot, FairSoft, R3BRoot"
  ],
  "author": [
    {
      "@type": "Person",
      "@id": "https://orcid.org/0000-0002-4702-5294",
      "givenName": "Jose Luis",
      "familyName": "Rodríguez-Sánchez",
      "email": "j.l.rodriguez.sanchez@udc.es",
      "affiliation": "CITENI, Industrial Campus of Ferrol, University of Coruña, Spain"
    }
  ]
}

GitHub Events

Total
  • Release event: 6
  • Delete event: 4
  • Push event: 44
  • Create event: 7
Last Year
  • Release event: 6
  • Delete event: 4
  • Push event: 44
  • Create event: 7

Dependencies

.github/workflows/main.yml actions
  • actions/checkout v3 composite