Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
Update copyright

Complete the list of authors

Added more authors

Update headers
  • Loading branch information
jose-luis-rs committed Dec 23, 2024
1 parent 1bc79f4 commit eac5b23
Show file tree
Hide file tree
Showing 18 changed files with 177 additions and 64 deletions.
5 changes: 3 additions & 2 deletions .github/workflows/check_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ jobs:
steps:
- uses: actions/checkout@v4
- name: Try updating metadata
run: python meta_update.py
run: python update_zenodo.py
- name: Check for Updates
run: git diff --exit-code
run: |
git diff --exit-code || (echo "Metadata files require updates. Please commit the changes." && exit 1)
50 changes: 44 additions & 6 deletions .zenodo.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
{
"description": "The SOFIA module within the R3BRoot framework encapsulates the configuration and functionality of the SOFIA detectors, specifically designed for fission experiments conducted with the GLAD spectrometer. R3BRoot, built on the FairRoot framework, serves as a software environment for performing detailed Monte Carlo simulations and processing experimental data from R3B (Reactions with Relativistic Radioactive Beams) experiments. These capabilities include precise modeling of detector geometry, particle tracking, event reconstruction, and physics analysis, supporting the investigation of fission dynamics and nuclear structure in high-energy heavy-ion collision scenarios at the GSI-FAIR facility.",
"access_right": "open",
"description": "The SOFIA software module, integrated into the R3BRoot framework, provides comprehensive tools for configuring and managing the SOFIA detector analysis, specifically designed for nuclear fission experiments performed with the GLAD superconducting spectrometer. Sofia-R3BRoot, built on the FairRoot framework, offers a robust software environment for conducting detailed Monte Carlo simulations and processing experimental data from R3B (Reactions with Relativistic Radioactive Beams) experiments. Key features include precise detector geometry modeling, particle tracking, event reconstruction, and physics analysis, all of which support the study of fission dynamics and nuclear structure in high-energy heavy-ion collision scenarios at the GSI-FAIR facility. The SOFIA software package is distributed as a source release, with regular updates available for macOS and Linux.",
"related_identifiers": [
{
"identifier": "https://github.com/FairRootGroup/FairSoft/",
"relation": "isDerivedFrom",
"resource_type": "software",
"scheme": "url"
},
{
"identifier": "https://github.com/FairRootGroup/FairRoot/",
"relation": "isDerivedFrom",
Expand All @@ -9,7 +16,13 @@
},
{
"identifier": "https://github.com/R3BRootGroup/R3BRoot/",
"relation": "isSupplementTo",
"relation": "isDerivedFrom",
"resource_type": "software",
"scheme": "url"
},
{
"identifier": "https://gitlab.com/chalmers-subexp/ucesb/",
"relation": "isRelatedTo",
"resource_type": "software",
"scheme": "url"
},
Expand Down Expand Up @@ -67,15 +80,27 @@
"affiliation": "CITENI, Industrial Campus of Ferrol, University of Coruña, 15403 Ferrol, Spain"
},
{
"name": "Alvarez Pol, Hector",
"name": "Chatillon, Audrey",
"orcid": "0000-0001-9488-5484",
"email": "[email protected]",
"affiliation": "CEA, DAM, DIF, 91297 Arpajon, France"
},
{
"name": "Alvarez-Pol, Hector",
"orcid": "0000-0001-9643-6252",
"email": "[email protected]",
"affiliation": "IGFAE, University of Santiago de Compostela, 15782 Santiago de Compostela, Spain"
},
{
"name": "Chatillon, Audrey",
"orcid": "0000-0001-9488-5484",
"email": "[email protected]",
"name": "Audouin, Laurent",
"orcid": "0000-0001-9899-6923",
"email": "[email protected]",
"affiliation": "IPN Orsay, 91406 Orsay, France"
},
{
"name": "Blanchon, Guillaume",
"orcid": "0000-0002-3786-9143",
"email": "[email protected]",
"affiliation": "CEA, DAM, DIF, 91297 Arpajon, France"
},
{
Expand All @@ -86,11 +111,18 @@
{
"name": "Graña-González, Antia",
"orcid": "0000-0002-0842-4110",
"email": "[email protected]",
"affiliation": "CITENI, Industrial Campus of Ferrol, University of Coruña, 15403 Ferrol, Spain"
},
{
"name": "Morfouace, Pierre",
"orcid": "0000-0002-2131-2199",
"email": "[email protected]",
"affiliation": "CEA, DAM, DIF, 91297 Arpajon, France"
},
{
"name": "Taïeb, Julien",
"email": "[email protected]",
"affiliation": "CEA, DAM, DIF, 91297 Arpajon, France"
},
{
Expand All @@ -105,6 +137,12 @@
"name": "Mayer, Jan",
"affiliation": "Technical University of Berlin, 10587 Berlin, Germany"
},
{
"type": "Other",
"name": "Klenze, Philipp",
"orcid": "0000-0001-5709-7315",
"affiliation": "GSI Helmholtzzentrum für Schwerionenforschung, 64291 Darmstadt, Germany"
},
{
"type": "Other",
"name": "Wang, Yanzhao",
Expand Down
9 changes: 6 additions & 3 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
Rodríguez-Sánchez, Jose Luis [[email protected]] [https://orcid.org/0000-0002-4702-5294] [CITENI, Industrial Campus of Ferrol, University of Coruña, 15403 Ferrol, Spain]
Alvarez Pol, Hector [[email protected]] [https://orcid.org/0000-0001-9643-6252] [IGFAE, University of Santiago de Compostela, 15782 Santiago de Compostela, Spain]
Chatillon, Audrey [[email protected]] [https://orcid.org/0000-0001-9488-5484] [CEA, DAM, DIF, 91297 Arpajon, France]
Alvarez-Pol, Hector [[email protected]] [https://orcid.org/0000-0001-9643-6252] [IGFAE, University of Santiago de Compostela, 15782 Santiago de Compostela, Spain]
Audouin, Laurent [[email protected]] [https://orcid.org/0000-0001-9899-6923] [IPN Orsay, 91406 Orsay, France]
Blanchon, Guillaume [[email protected]] [https://orcid.org/0000-0002-3786-9143] [CEA, DAM, DIF, 91297 Arpajon, France]
García-Jiménez, Gabriel [https://orcid.org/0000-0002-4435-0163] [IGFAE, University of Santiago de Compostela, 15782 Santiago de Compostela, Spain]
Graña-González, Antia [https://orcid.org/0000-0002-0842-4110] [CITENI, Industrial Campus of Ferrol, University of Coruña, 15403 Ferrol, Spain]
Morfouace, Pierre [https://orcid.org/0000-0002-2131-2199] [CEA, DAM, DIF, 91297 Arpajon, France]
Graña-González, Antia [[email protected]] [https://orcid.org/0000-0002-0842-4110] [CITENI, Industrial Campus of Ferrol, University of Coruña, 15403 Ferrol, Spain]
Morfouace, Pierre [[email protected]] [https://orcid.org/0000-0002-2131-2199] [CEA, DAM, DIF, 91297 Arpajon, France]
Taïeb, Julien [[email protected]] [CEA, DAM, DIF, 91297 Arpajon, France]
Taniuchi, Ryo [https://orcid.org/0000-0002-8057-7074] [School of Physics, Engineering and Technology, University of York, YO10 5DD York, UK]
1 change: 1 addition & 0 deletions CONTRIBUTORS
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
Mayer, Jan [Technical University of Berlin, 10587 Berlin, Germany]
Klenze, Philipp [https://orcid.org/0000-0001-5709-7315] [GSI Helmholtzzentrum für Schwerionenforschung, 64291 Darmstadt, Germany]
Wang, Yanzhao [https://orcid.org/0000-0002-7006-7986] [Universität zu Köln, 50923 Köln, Germany]
6 changes: 3 additions & 3 deletions COPYRIGHT
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ Upstream-Contact: Jose Luis Rodríguez-Sánchez <[email protected]>
Source: https://github.com/R3BRootGroup/sofia

Files: *
Copyright: 2017-2024, GSI Helmholtzzentrum fuer Schwerionenforschung GmbH
Copyright: 2017-2024, [see AUTHORS file]
Copyright: 2017-2024, [see CONTRIBUTORS file]
Copyright: 2017-2025, GSI Helmholtzzentrum fuer Schwerionenforschung GmbH
Copyright: 2017-2025, [see AUTHORS file]
Copyright: 2017-2025, [see CONTRIBUTORS file]
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![static analysis](https://github.com/R3BRootGroup/sofia/actions/workflows/static_analysis.yml/badge.svg)](https://github.com/R3BRootGroup/sofia/actions/workflows/static_analysis.yml) [![CI-CD](https://github.com/R3BRootGroup/sofia/actions/workflows/main.yml/badge.svg)](https://github.com/R3BRootGroup/sofia/actions/workflows/main.yml)

## The SOFIA Framework
The SOFIA module within the R3BRoot framework encapsulates the configuration and functionality of the SOFIA detectors, specifically designed for fission experiments conducted with the GLAD spectrometer. R3BRoot, built on the FairRoot framework, serves as a software environment for performing detailed Monte Carlo simulations and processing experimental data from R3B (Reactions with Relativistic Radioactive Beams) experiments. These capabilities include precise modeling of detector geometry, particle tracking, event reconstruction, and physics analysis, supporting the investigation of fission dynamics and nuclear structure in high-energy heavy-ion collision scenarios at the GSI-FAIR facility.
The SOFIA software module within the [R3BRoot](https://github.com/R3BRootGroup/R3BRoot) framework encapsulates the configuration and functionality of the SOFIA detectors, specifically designed for fission experiments conducted with the GLAD spectrometer. Sofia-R3BRoot, built on the FairRoot framework, serves as a software environment for performing detailed Monte Carlo simulations and processing experimental data from R3B (Reactions with Relativistic Radioactive Beams) experiments. These capabilities include precise modeling of detector geometry, particle tracking, event reconstruction, and physics analysis, supporting the investigation of fission dynamics and nuclear structure in high-energy heavy-ion collision scenarios at the GSI-FAIR facility. The SOFIA software package is a source distribution with recurring releases for macOS and Linux.

## Discussion Forum
For the software-related user support you can post a new topic on our [forum](https://forum.gsi.de/index.php?t=index&cat=40&).
Expand Down
24 changes: 12 additions & 12 deletions codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"issueTracker": "https://github.com/R3BRootGroup/sofia/issues",
"name": "sofia",
"softwareVersion": "dec24",
"description": "Software for the SOFIA/R3B fission experiments at FAIR",
"description": "Software for the SOFIA/R3B fission experiments at GSI/FAIR",
"readme": "https://github.com/R3BRootGroup/sofia/blob/dev/README.md",
"releaseNotes": "",
"applicationCategory": "Nuclear physics",
Expand Down Expand Up @@ -47,21 +47,27 @@
"maintainer": {
"@type": "Person",
"givenName": "Jose Luis",
"familyName": "Rodriguez Sanchez",
"familyName": "Rodriguez-Sanchez",
"@id": "https://orcid.org/0000-0002-4702-5294"
},
"author": [
{
"@type": "Person",
"givenName": "Hector",
"familyName": "Alvarez Pol",
"@id": "https://orcid.org/0000-0001-9643-6252"
"@type": "Person",
"givenName": "Jose Luis",
"familyName": "Rodriguez-Sanchez",
"@id": "https://orcid.org/0000-0002-4702-5294"
},
{
"@type": "Person",
"givenName": "Audrey",
"familyName": "Chatillon"
},
{
"@type": "Person",
"givenName": "Hector",
"familyName": "Alvarez-Pol",
"@id": "https://orcid.org/0000-0001-9643-6252"
},
{
"@type": "Person",
"givenName": "Gabriel",
Expand All @@ -79,12 +85,6 @@
"givenName": "Pierre",
"familyName": "Morfouace"
},
{
"@type": "Person",
"givenName": "Jose Luis",
"familyName": "Rodriguez Sanchez",
"@id": "https://orcid.org/0000-0002-4702-5294"
},
{
"@type": "Person",
"@id": "https://orcid.org/0000-0002-8057-7074",
Expand Down
16 changes: 14 additions & 2 deletions tcal/R3BSofSciRawTofPar.cxx
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
/******************************************************************************
* Copyright (C) 2017 GSI Helmholtzzentrum für Schwerionenforschung GmbH *
* Copyright (C) 2017-2025 Members of R3B Collaboration *
* *
* This software is distributed under the terms of the *
* GNU Lesser General Public Licence (LGPL) version 3, *
* copied verbatim in the file "LICENSE". *
* *
* In applying this license GSI does not waive the privileges and immunities *
* granted to it by virtue of its status as an Intergovernmental Organization *
* or submit itself to any jurisdiction. *
******************************************************************************/

#include "R3BSofSciRawTofPar.h"

#include "FairLogger.h"
Expand Down Expand Up @@ -127,5 +140,4 @@ void R3BSofSciRawTofPar::printParams()
LOG(info) << "LIMIT " << param << " = " << fAllSignalsRawTofParams->GetAt(param);
}
}

ClassImp(R3BSofSciRawTofPar);
ClassImp(R3BSofSciRawTofPar)
18 changes: 14 additions & 4 deletions tcal/R3BSofSciRawTofPar.h
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
#ifndef __R3BSOFSCIRAWTOFPAR_H__
#define __R3BSOFSCIRAWTOFPAR_H__ 1
/******************************************************************************
* Copyright (C) 2017 GSI Helmholtzzentrum für Schwerionenforschung GmbH *
* Copyright (C) 2017-2025 Members of R3B Collaboration *
* *
* This software is distributed under the terms of the *
* GNU Lesser General Public Licence (LGPL) version 3, *
* copied verbatim in the file "LICENSE". *
* *
* In applying this license GSI does not waive the privileges and immunities *
* granted to it by virtue of its status as an Intergovernmental Organization *
* or submit itself to any jurisdiction. *
******************************************************************************/

#pragma once

#include "FairParGenericSet.h" // for FairParGenericSet
#include "TArrayF.h"
Expand Down Expand Up @@ -70,5 +82,3 @@ class R3BSofSciRawTofPar : public FairParGenericSet

ClassDef(R3BSofSciRawTofPar, 1);
};

#endif //__R3BSOFSCIRAWTOFPAR_H__
16 changes: 14 additions & 2 deletions tcal/R3BSofTcalContFact.cxx
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
/******************************************************************************
* Copyright (C) 2017 GSI Helmholtzzentrum für Schwerionenforschung GmbH *
* Copyright (C) 2017-2025 Members of R3B Collaboration *
* *
* This software is distributed under the terms of the *
* GNU Lesser General Public Licence (LGPL) version 3, *
* copied verbatim in the file "LICENSE". *
* *
* In applying this license GSI does not waive the privileges and immunities *
* granted to it by virtue of its status as an Intergovernmental Organization *
* or submit itself to any jurisdiction. *
******************************************************************************/

// ----------------------------------------------------------------
// ----- R3BSofTcalContFact source file -----
// ----- Created 22/09/18 by J.L. Rodriguez-Sanchez -----
Expand Down Expand Up @@ -92,5 +105,4 @@ FairParSet* R3BSofTcalContFact::createContainer(FairContainer* c)

return p;
}

ClassImp(R3BSofTcalContFact);
ClassImp(R3BSofTcalContFact)
24 changes: 14 additions & 10 deletions tcal/R3BSofTcalContFact.h
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
// -------------------------------------------------------------------
// -----
// Factory for the parameter containers in libR3BSofTcal -----
// -----
// -------------------------------------------------------------------

#ifndef R3BSOFTCALCONTFACT_H
#define R3BSOFTCALCONTFACT_H
/******************************************************************************
* Copyright (C) 2017 GSI Helmholtzzentrum für Schwerionenforschung GmbH *
* Copyright (C) 2017-2025 Members of R3B Collaboration *
* *
* This software is distributed under the terms of the *
* GNU Lesser General Public Licence (LGPL) version 3, *
* copied verbatim in the file "LICENSE". *
* *
* In applying this license GSI does not waive the privileges and immunities *
* granted to it by virtue of its status as an Intergovernmental Organization *
* or submit itself to any jurisdiction. *
******************************************************************************/

#pragma once

#include "FairContFact.h"

Expand All @@ -24,5 +30,3 @@ class R3BSofTcalContFact : public FairContFact

ClassDef(R3BSofTcalContFact, 1);
};

#endif // R3BTCALCONTFACT_H
15 changes: 14 additions & 1 deletion tcal/R3BSofTcalPar.cxx
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
/******************************************************************************
* Copyright (C) 2017 GSI Helmholtzzentrum für Schwerionenforschung GmbH *
* Copyright (C) 2017-2025 Members of R3B Collaboration *
* *
* This software is distributed under the terms of the *
* GNU Lesser General Public Licence (LGPL) version 3, *
* copied verbatim in the file "LICENSE". *
* *
* In applying this license GSI does not waive the privileges and immunities *
* granted to it by virtue of its status as an Intergovernmental Organization *
* or submit itself to any jurisdiction. *
******************************************************************************/

#include "R3BSofTcalPar.h"

#include "FairDetParIo.h"
Expand Down Expand Up @@ -137,4 +150,4 @@ void R3BSofTcalPar::printParams()
}
}

ClassImp(R3BSofTcalPar);
ClassImp(R3BSofTcalPar)
18 changes: 14 additions & 4 deletions tcal/R3BSofTcalPar.h
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
#ifndef R3BSOFTCALPAR_H
#define R3BSOFTCALPAR_H
/******************************************************************************
* Copyright (C) 2017 GSI Helmholtzzentrum für Schwerionenforschung GmbH *
* Copyright (C) 2017-2025 Members of R3B Collaboration *
* *
* This software is distributed under the terms of the *
* GNU Lesser General Public Licence (LGPL) version 3, *
* copied verbatim in the file "LICENSE". *
* *
* In applying this license GSI does not waive the privileges and immunities *
* granted to it by virtue of its status as an Intergovernmental Organization *
* or submit itself to any jurisdiction. *
******************************************************************************/

#pragma once

#include "FairParGenericSet.h"
#include "TArrayF.h"
Expand Down Expand Up @@ -79,5 +91,3 @@ class R3BSofTcalPar : public FairParGenericSet

ClassDef(R3BSofTcalPar, 1);
};

#endif // R3BSOFTCALPAR_H
Loading

0 comments on commit eac5b23

Please sign in to comment.