Skip to content

Commit e48e6de

Browse files
Finalised with minor edits and links added
1 parent fc0a180 commit e48e6de

File tree

1 file changed

+26
-15
lines changed

1 file changed

+26
-15
lines changed

projects/affiliated.md

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,37 +7,40 @@ HSF Affiliated Projects and Software
77

88
## Definitions
99

10-
HSF Affiliated Projects and Software are community-driven and community-oriented endeavours or products of wide and recognised interest and applicability beyond a single collaboration or experiment.
10+
*HSF Affiliated Projects and Software* are community-driven and community-oriented "endeavours" or "products" of wide and recognised interest and applicability beyond a single collaboration or experiment.
1111

12-
HSF Affiliated Projects and Software are community projects or software packages with person-power, and possibly dedicated funding, which connect strongly to the HSF and align with [its remit](https://hepsoftwarefoundation.org/organization/goals.html). They benefit from their inclusion in, or association with, the HSF through access to the community for wide visibility and easier promotion through the network. Affiliation makes it clear that the HSF has no control over the endeavours/products, hence no responsibility for evolution or maintenance.
12+
*HSF Affiliated Projects and Software* are community projects or software packages with person-power, and possibly dedicated funding, which connect strongly to the HSF and align with [its remit]({{ site.baseurl }}/organization/goals.html). They benefit from their inclusion in, or association with, the HSF through access to the community for wide visibility and easier promotion through the network. Affiliation makes it clear that the HSF has no control over the endeavours/products, hence no responsibility for evolution or maintenance.
1313

1414
Projects are in general not hosted on the HSF GitHub repository since they are externally managed and maintained, though some are on the [HSF GitHub repository](https://github.com/HSF).
1515

1616
## Engagement and endorsement
1717

18-
Any member of the community is welcome to engage with the HSF in general and the HSF Steering Group (SG), in particular to discuss the route towards making a software project or package an HSF Affiliated Project or Software. This can be an informal discussion initially.
18+
Any member of the community is welcome to engage with the HSF in general and the
19+
[HSF Steering Group (SG)]({{ site.baseurl }}/organization/team.html),
20+
in particular to discuss the route towards making a software project or package an HSF Affiliated Project or Software. This can be an informal discussion initially.
1921

20-
Formal endorsement is provided by the HSF SG following a short evaluation period in consultation with the relevant HSF Working Group conveners and community experts. For transparency, these evaluations (start, scope and end) are advertised publicly via the HSF Forum, the HSFs main means of communication.
22+
Formal endorsement is provided by the HSF SG following a short evaluation period in consultation with the relevant HSF Working Group conveners and community experts. For transparency, these evaluations (start, scope and end) are advertised publicly via the HSF Forum, the HSF's main means of communication.
2123

2224
The list of HSF Affiliated Projects and Software is hosted in a dedicated area on the HSF website, curated and maintained by the HSF SG.
2325

24-
The recognition of bijective engagement with the HSF is displayed via GitHub Badges. Three levels distinguish mainly the level of maturity, community support and
25-
engagement: Bronze, Silver and Gold. In broad terms, the attribution of the endorsement level is based on the following guidelines, which are detailed in the dedicated document on Guidelines for HSF Affiliated Projects and Software, and Endorsement Badge Levels.
26-
- Bronze: new or young endeavour, likely evolving from and within a collaboration or experiment, but with the potential for other communities to use. It should be committed to meeting best practices in software engineering, e.g., documentation and a test suite.
27-
- Silver: aiming for gold but in an earlier phase towards strong community support (e.g., adoption is still relatively shy, maintenance is not secured at least in the medium term by more than a single person). High standards of software engineering should be met.
28-
- Gold: endeavour adopted by several collaborations and/or experiments with a strong and long-term community support model.
26+
The recognition of bijective engagement with the HSF is displayed via *GitHub Badges*.
27+
Three levels distinguish mainly the level of maturity, community support and engagement: Bronze, Silver and Gold.
28+
In broad terms, the attribution of the endorsement level is based on the following guidelines, which are detailed in the dedicated document on Guidelines for HSF Affiliated Projects and Software, and Endorsement Badge Levels.
29+
* Bronze: new or young endeavour, likely evolving from and within a collaboration or experiment, but with the potential for other communities to use. It should be committed to meeting best practices in software engineering, e.g., documentation and a test suite.
30+
* Silver: aiming for gold but in an earlier phase towards strong community support (e.g., adoption is still relatively shy, maintenance is not secured at least in the medium term by more than a single person). High standards of software engineering should be met.
31+
* Gold: endeavour adopted by several collaborations and/or experiments with a strong and long-term community support model.
2932

3033
The HSF envisages a scheme for Annual Project Awards. A concrete proposal will be presented to the HSF Advisory Group once the latter is put in place.
3134

3235
## Best-practice guidelines
3336

3437
They are detailed in the document Guidelines for HSF (Affiliated) Projects and Software.
3538

36-
## HSF Reviews
39+
## HSF "Reviews"
3740

3841
The HSF can organise informal reviews of community projects upon request. Such reviews bring together a group of experts from the community to assess all aspects of a project or software, from requirements to implementation: code, packaging, documentation, etc.
3942

40-
The reviews are organised by the HSF SG in consultation with relevant Working Group conveners. For transparency, these reviews (start, scope and end) are advertised publicly via the HSF Forum, the HSFs main means of communication, and the results are made public.
43+
The reviews are organised by the HSF SG in consultation with relevant Working Group conveners. For transparency, these reviews (start, scope and end) are advertised publicly via the HSF Forum, the HSF's main means of communication, and the results are made public.
4144

4245
## HSF Requirements and Reference Implementation
4346

@@ -49,17 +52,25 @@ Where there is a problem domain in the field that has not been studied from a ge
4952
In the first phase, experts from multiple experiments and communities should undertake a process of writing a White Paper, with wide community consultation and endorsement, which describes the problem to be solved in terms of specific and concrete requirements.
5053
The requirements can then be used as the basis for a public API specification, to which specific solutions should adhere to.
5154
The HSF can facilitate the development of solutions, which will become an Affiliated Project or Software irrespective of the concrete circumstances and sources of effort and funding.
52-
The model for this process was the development of the conditions database used by sPHENIX, as developed by the BNL NPPS group, following the problem definition developed in the HSF Conditions Database Working Group [2401.16274].
55+
The model for this process was the development of the conditions database used by sPHENIX, as developed by the BNL NPPS group, following the problem definition developed in the HSF Conditions Database Working Group [arXiv:2401.16274](https://doi.org/10.48550/arXiv.2401.16274).
5356

5457
## Letters of Support and Cooperation
5558

56-
Please refer to the document HSF letters on the website. The HSF continues to provide letters on the same basis.
59+
Please refer to the document
60+
[HSF letters]({{ site.baseurl }}/organization/hsf-letters.html)
61+
on the website. The HSF continues to provide letters on the same basis.
5762

5863
## Funding Support
5964

60-
The HSF is a community organisation with no internal source of funding. It runs as a do-ocracy. In the spirit that the HSF facilitates cooperation and common efforts in HEP software and computing internationally, the HSF envisages facilitating the availability of modest financial support for community colleagues to travel and present at important events. This is inspired, broadly speaking, by the concept of NumFOCUS Affiliated Projects. The HSF will highlight external funding opportunities available for software projects.
65+
The HSF is a community organisation with no internal source of funding.
66+
It runs as a do-ocracy. In the spirit that the HSF facilitates cooperation and common efforts in HEP software and computing internationally, the HSF envisages facilitating the availability of modest financial support for community colleagues to travel and present at important events.
67+
This is inspired, broadly speaking, by the concept of
68+
[NumFOCUS Affiliated Projects](https://numfocus.org/sponsored-projects/affiliated-projects).
69+
The HSF will highlight external funding opportunities available for software projects.
6170

62-
Entities interested in acting as Sponsors make themselves known to the HSF SG stating the level of funding they will make available per annum, and for what type of activity(ies) - e.g., presentation of a software package by an Early Career Scientist at a major conference, travel support for a seminar. The HSF SG curates the list of Sponsors on the website, displaying the requirements to be met by each Sponsor. The HSF will not be in charge of financial transactions, it will merely serve as a mediator.
71+
Entities interested in acting as Sponsors make themselves known to the HSF SG stating the level of funding they will make available per annum, and for what type of activity(ies) - e.g., presentation of a software package by an Early Career Scientist at a major conference, travel support for a seminar.
72+
The HSF SG curates the list of Sponsors on the website, displaying the requirements to be met by each Sponsor.
73+
The HSF will not be in charge of financial transactions, it will merely serve as a mediator.
6374

6475
Entities can be any moral entity or persons.
6576

0 commit comments

Comments
 (0)