Skip to content

Commit

Permalink
adding GPT information
Browse files Browse the repository at this point in the history
  • Loading branch information
Jutta Schnabel committed Jan 8, 2025
1 parent 12a38d1 commit 8ecd0ed
Show file tree
Hide file tree
Showing 20 changed files with 1,020 additions and 10 deletions.
13 changes: 13 additions & 0 deletions codemeta.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,17 @@
"description": "Outcome and analysis of the EVERSE software quality survey.",
"readme": "https://github.com/YouSchnabel/EVERSE-landscape/blob/main/README.md",
"softwareVersion": "0.1",
"author": [
{
"@type": "Person",
"givenName": "Jutta",
"familyName": "Schnabel",
"email": "[email protected]",
"affiliation": {
"@type": "Organization",
"name": "FAU Erlangen, ECAP"
}
}
]

}
1 change: 1 addition & 0 deletions data/structure.yml
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
pdfname: EVERSE_survey_results.pdf
api_key: ""
scales:
scale_highlow:
options: ['very low', 'low', 'medium', 'high', 'very high']
Expand Down
78 changes: 78 additions & 0 deletions docs/pages/chap_community.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,83 @@
### Level of confidence for answers in this section

![Level of confidence for answers in this section](figures/plot_rating_A86.png)
## Auto-created summary
### Summary of Mentioned Practices

1. **Co-Creation with Stakeholders**
- Guideline: OpenAIRE Interoperability Guidelines
- Description: Collaboration with stakeholders to create shared solutions.
- [Relevance Rank: 7]

2. **Training and Tutorials**
- Guideline: Various guidelines including resources from CERN and Software Carpentry
- Description: Offering training and tutorials to disseminate knowledge and enhance participant skills.
- [Relevance Rank: 6, 10, 22]

3. **Journal Guidelines for Software Publications**
- Guideline: JOSS
- Description: Guidelines provided for publishing software in academic journals.
- [Relevance Rank: 8]

4. **Ability to Perform Pull Requests and Open Issues**
- Guideline: GitHub guidelines for repository contributions
- Description: Encouraging contributions through clear repository guidelines.
- [Relevance Rank: 12]

5. **Enabling Community Contribution with Use of Code Repositories**
- Guideline: Public GitHub repositories
- Description: Facilitating community contributions via accessible code repositories.
- [Relevance Rank: 20]

6. **Monitoring Software Usage for Feedback**
- Guideline: Matomo for web applications
- Description: Tracking software usage to improve user experience and functionality.
- [Relevance Rank: 20]

7. **Open Science Training and Advocacy**
- Guideline: OpenAIRE Open Training resources
- Description: Promoting open science practices through training.
- [Relevance Rank: 7]

8. **Open Decision Making**
- Description: Involving community in decision-making processes.
- [Relevance Rank: 21]

9. **Publication and Presentation Repositories**
- Guideline: Various platforms including Zenodo, Indico, and InspireHEP
- Description: Providing repositories for sharing academic publications and presentations.
- [Relevance Rank: 6]

10. **Team Building in Scientific Communities**
- Guideline: Gammapy team example
- Description: Building cohesive teams within scientific collaborations.
- [Relevance Rank: 10]

11. **deRSE Position Paper**
- Description: Document addressing research software inclusion and practices.
- [Relevance Rank: 11]

### Linked URLs and Descriptions

| URL | Description |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|
| [https://guidelines.openaire.eu/en/latest/](https://guidelines.openaire.eu/en/latest/) | Guidelines for interoperability in open science practices |
| [https://joss.readthedocs.io/en/latest/index.html](https://joss.readthedocs.io/en/latest/index.html) | Journal of Open Source Software (JOSS) guidelines |
| [https://gammapy.org/team.html](https://gammapy.org/team.html) | Example of team building within a scientific project |
| [https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors) | GitHub guidelines for repository contributions |
| [https://indico.cern.ch/event/1295479/overview](https://indico.cern.ch/event/1295479/overview) | Example of training and tutorials provided in developer workshops |
| [https://lms.cern.ch/](https://lms.cern.ch/) | CERN training resources |
| [https://hepsoftwarefoundation.org/workinggroups/training.html](https://hepsoftwarefoundation.org/workinggroups/training.html) | High Energy Physics Software Foundation training group |
| [https://lhcb.github.io/starterkit-lessons/](https://lhcb.github.io/starterkit-lessons/) | Training materials for LHCb |
| [https://escape2020.github.io](https://escape2020.github.io) | Community event training example |
| [https://matomo.org/)](https://matomo.org/)) | Analytics tool for monitoring software usage |
| [https://zenodo.org/](https://zenodo.org/) | Repository for sharing academic publications and presentations |
| [https://indico.cern.ch/](https://indico.cern.ch/) | CERN's platform for scheduling meetings and events |
| [https://inspirehep.net/](https://inspirehep.net/) | Database for high-energy physics academic papers |
| [https://cds.cern.ch/?ln=en](https://cds.cern.ch/?ln=en) | CERN Document Server for collecting and maintaining CERN documentations |
| [https://edms-service.web.cern.ch/faq/EDMS/pages/](https://edms-service.web.cern.ch/faq/EDMS/pages/) | CERN's Engineering Data Management Service |
| [https://www.openaire.eu/opentraining](https://www.openaire.eu/opentraining) | OpenAIRE resources for open science training |
| [https://software-carpentry.org](https://software-carpentry.org) | Software Carpentry's training resources |

## Community involvement

21 changes: 21 additions & 0 deletions docs/pages/chap_ethics.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,26 @@
### Level of confidence for answers in this section

![Level of confidence for answers in this section](figures/plot_rating_A86.png)
## Auto-created summary
### Summary of Practices

- **Unbiased data selection**
- Description: Emphasizes the importance of selecting data in a non-biased manner to maintain ethical standards in research or software development.

- **Open code repositories**
- Description: Ensures that almost all developed software is available and accessible via open platforms like GitLab and GitHub, promoting transparency and collaboration.

- **FAIR Principles for Software**
- Description: Adopting the FAIR (Findable, Accessible, Interoperable, Reusable) Principles to enhance the quality and reliability of research software.

- **Openness and Integrity in Open Source Projects**
- Description: Prioritizes the protection of openness and integrity in open-source and open-access projects to maintain trust and transparency.

### Linked URLs and Descriptions

| URL | Description |
|------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------|
| [https://doi.org/10.1038/s41597-022-01710-x](https://doi.org/10.1038/s41597-022-01710-x) | Introduction to the FAIR Principles for research software. |
| [https://acts.readthedocs.io/en/latest/contribution/contribution.html](https://acts.readthedocs.io/en/latest/contribution/contribution.html) | Guidelines for maintaining openness and integrity in open-source projects. |
## Ethics

17 changes: 17 additions & 0 deletions docs/pages/chap_finance.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,22 @@
|---:|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------|
| 10 | recently, the EU OSCARS project [https://oscars-project.eu](https://oscars-project.eu) had funding opportunities for research including software - this is an example for side funding: | side funding |

## Auto-created summary
### Summary of Practices

- **Maintenance Funding**: There is a significant gap in financial support for software maintenance across research projects, which affects long-term maintenance viability, with funding often required for both researchers and hardware infrastructure.
- **Quality Assurance**: Limited to no funding is reported for ensuring software quality, affecting the development of high-quality research software.
- **Permanent Positions for Research Software Engineers (RSEs)**: There is almost no funding available for permanent RSE positions, which could help in maintaining and improving research software.
- **Infrastructure Access**: Many projects face a lack of continued financial support for necessary infrastructure to run software.
- **Funding Focus**: Most available funds are focused on initial development rather than maintenance and archiving.

### Linked URLs Table

| URL | Description |
|---------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|
| [https://www.dfg.de/de/foerderung/foerdermoeglichkeiten/programme/infrastruktur/lis/lis-foerderangebote/forschungssoftwareinfrastrukturen](https://www.dfg.de/de/foerderung/foerdermoeglichkeiten/programme/infrastruktur/lis/lis-foerderangebote/forschungssoftwareinfrastrukturen) | German DFG program for research software infrastructures |
| [https://www.archer2.ac.uk/ecse/](https://www.archer2.ac.uk/ecse/) | Funding for technical professionals to work on research code |
| [https://www.esciencecenter.nl](https://www.esciencecenter.nl) | Netherlands eScience Centre funding |
| [https://oscars-project.eu](https://oscars-project.eu) | EU OSCARS project with side funding opportunities for research including software |
## Financial support

54 changes: 54 additions & 0 deletions docs/pages/chap_infrastructure.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,5 +93,59 @@
| | [https://posit.co/](https://posit.co/) | | |
| 27 | [https://helmholtz.software,](https://helmholtz.software,) [https://helmholtz.software,](https://helmholtz.software,) [https://www.softwareheritage.org](https://www.softwareheritage.org) | Open/free platform; Institute or Organization; Large scale infrastructure | no |

## Auto-created summary
### Summary of Mentioned Practices

#### 1. **OpenDMP and ARGOS**
- **Description**: Open extensible service for managing Data Management Plans (DMPs) that assists in the management, validation, monitoring, and maintenance of DMPs, facilitating exchanges among infrastructures.
- **Relevance**: Key tool for managing research data, ensuring compliance with data management requirements.
- **Link**: [ARGOS](https://argos.openaire.eu/splash/about/how-it-works.html)

#### 2. **GitHub and GitLab**
- **Description**: Widely used platforms for code hosting, development, version control, and project management, with capabilities like CI/CD pipelines.
- **Relevance**: Central tools for software development and maintenance across various projects.
- **Links**: [GitHub](https://github.com), [GitLab](https://gitlab.com)

#### 3. **Zenodo and Software Heritage**
- **Description**: Platforms for archiving research outputs, including software, data, and publications, offering long-term preservation solutions.
- **Relevance**: Crucial for ensuring the availability and integrity of research outputs.
- **Links**: [Zenodo](https://zenodo.org), [Software Heritage](https://www.softwareheritage.org/)

#### 4. **Netherlands eScience Center**
- **Description**: Provides infrastructure support for both planning and development phases in projects, though currently considering focusing solely on planning.
- **Relevance**: Supports research efforts by combining planning with development support for comprehensive project management.

#### 5. **CERN GitLab and Issue Tracking**
- **Description**: GitLab instances with integrated storage and compute infrastructure, along with a JIRA instance for issue tracking.
- **Relevance**: Essential for managing large-scale, complex scientific projects with significant computational needs.

#### 6. **Open Source Software Repositories**
- **Description**: Repositories such as npmjs.com, pypi.org, and bioconda, are used for distribution and maintenance of software packages.
- **Relevance**: Supports the longevity and accessibility of software through widespread distribution.

#### 7. **Data Repositories like B2SHARE and CLARIN**
- **Description**: Platforms for sharing and preserving data within specific communities or institutions, ensuring compliance with data governance policies.
- **Relevance**: Important for fostering collaboration and ensuring data integrity and availability.
- **Links**: [B2SHARE](https://b2share.eudat.eu), [CLARIN](https://www.clarin.eu/content/clarin-nutshell)

### Linked URLs and Descriptions

| URL | Description |
|---------------------------------------------------|-----------------------------------------------------------------------------------------------|
| [https://argos.openaire.eu/splash/about/how-it-works.html](https://argos.openaire.eu/splash/about/how-it-works.html) | Description of how the ARGoS DMP tool functions. |
| [https://docs.github.com/en/issues/planning-and-tracking-with-projects/learning-about-projects/best-practices-for-projects](https://docs.github.com/en/issues/planning-and-tracking-with-projects/learning-about-projects/best-practices-for-projects) | GitHub documentation on best practices for planning and tracking projects. |
| [https://github.com](https://github.com) | GitHub platform for hosting, version control, and collaboration. |
| [https://gitlab.com](https://gitlab.com) | GitLab platform for hosting and managing software development projects. |
| [https://gitlab.bsc.es](https://gitlab.bsc.es) | BSC's GitLab instance for software development. |
| [https://git.km3net.de](https://git.km3net.de) | Git repository hosting specifically for KM3NeT collaboration. |
| [https://gitlab.in2p3.fr](https://gitlab.in2p3.fr)| IN2P3's GitLab instance used for software development. |
| [https://information-technology.web.cern.ch/services](https://information-technology.web.cern.ch/services) | CERN's IT services and infrastructure offerings. |
| [https://mybinder.org/](https://mybinder.org/) | MyBinder platform for making repositories executable by anyone, anywhere. |
| [https://edatos.consorciomadrono.es/](https://edatos.consorciomadrono.es/) | Data repository used by public universities in Madrid, Spain. |
| [https://zenodo.org](https://zenodo.org) | Zenodo platform for archiving and sharing research outputs. |
| [https://osf.io](https://osf.io) | Open Science Framework (OSF) for collaboration, management, and archiving projects. |
| [https://www.softwareheritage.org](https://www.softwareheritage.org) | Software Heritage: an archive of software source code for ensuring the preservation of software.|
| [https://posit.co/](https://posit.co/) | Platform formerly known as RStudio, providing tools for data science teams. |
| [https://codebase.helmholtz.cloud,](https://codebase.helmholtz.cloud) | Helmholtz Cloud's codebase repository for software sharing and development. |
## Infrastructure support

Loading

0 comments on commit 8ecd0ed

Please sign in to comment.