LGC Open-Source - April 2025 - APC/OSPO
Attendees: P. Elson, F. Klumb, J. Gutekunst, G.Kautzmann
License
Clearer formulation on the OSPO Level : Group Leader who has the final decision.
Choosing a License: a tool will be deployed mid-April to make the assessment.
From the external partners, no clear requirements expressed.
In the coming months, a security assessment will be made to check the CERN catalogue of development is it is compliant with the licenses. The survey does not need to include all the projects (too much work) but some flagship one per section could only be included. In the survey the identification of the licence can be done manually or by generating an SBOM file. For LGC, Surveylib and potentially SurveyPad, the repo should include a SBOM file (can be done with CMAKE?)
Actions:
- From mid- april use the OSPO tool and select a licence (ALL)
- Generate a SBOM for LGC first (ALL)
Code Copyright
LGC include a copyright to be reworked, be machine readable and checked.
Actions:
- Implementation of that process (pre-commit?) (GKA,JG with support of SuPad team and PE)
- Make the check by OSPO (PE)
GITHUB vs GITLAB.CERN.CH
A full migration to GitHub is excessive for now. Initial code development should remain on gitlab.cern.ch
, with automatic synchronization to GitHub for commits.
The repository should include a "How to Contribute" manual (contributors, etc.) that redirects to gitlab.cern.ch
for active contributions.
In the long term, if active collaboration increases significantly, a full migration to GitHub—with GitLab as a mirror—could be considered.
CI/CD rules and access to CERN resources can be restricted to CERN-approved members of the repository.
Open questions remain:
-
How can external contributors access
gitlab.cern.ch
? (e.g., lightweight accounts, GitHub authentication?) -
Alternatively, active development could be hosted on GitHub, synchronized with
gitlab.cern.ch
, with all CI/CD pipelines running on GitLab.
Actions:
- Check the synchronization option on a smaller project : LGCGateway on a personal/private repo (GKA)
- Add a how to contribute in the repo (GKA/JG + check by PE)
- Send documentation about the use of CI/CD by external and how to certify a contributor (PE)
GITHUB organisation
PE advised not to go on the CERN organisation in Github. Github does not support sub-orgnaisation like gitlab. Project to be considered : LGC2, Surveylib, SurveyPad + Plugins, Scripts?
Actions:
- Propose an organization in gitlab (APC global)
Documentation
Confluence documentation should be migrated to a public page. This includes the user manual, the JSON page, and the mathematical formulas. Two technologies are under consideration: Sphinx and MkDocs, with MkDocs proposed by PE. The LGC documentation page can be published on either GitHub or GitLab.
The rollout should be gradual: start with the user manual, followed by the mathematical model. The main documentation webpage should be versioned (e.g., using folders like current
, etc.). Publishing can be done on either GitHub or GitLab, depending on the chosen setup.
Actions:
- Make a first version of the documentation in mkdoc (1 to 1 migration) in v.2.8.0 and older (APC)
- Rework the user manual for v2.9.0 (APC) with consideration for versionning.
- Rules about the CERN logo ? (PE)
EWAA
Goal have a first version of open souce end of may. To present to the meeting EWAA beginning of June 2025.