CSCfi / CSCfi/csc-user-guide

Reproducibility section for apps

Open
#1,717 12 comments 2 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
67
Forks
109
Avg merge
2d 14h
Merged PRs (30d)
57

Description

How about adding a reproducibility section for Apps (where it makes sense)?

This would include how the app was installed by CSC (some package manager or built from source, using tykky, via container, etc) and then also link to environment.yml, Dockerfiles or Singularity definition files, which could be collected somewhere public.

I understand that only in some cases this helps the users, but I am also thinking here about for example other HPC centers.

environment, requirements, dockerfiles and definition files could for example be collected in a github repository under csc-training together with sharing course related computing environment setups (internally suggested in customer-training:

```
Collecting course environment information

Many of us create some kind of environment for our courses (eg own module on Puhti or some custom image for CSC Notebooks):
Shouldn't we collect information on them in some public space?

This would serve at least 3 purposes:

We/Our colleague know next year how we set up that course environment
The Dockerfiles, definition and module files would be version controlled
Customers that want to set up their own environment would have examples on how it's done and could copy and adapt our environments.

Maybe there could be a new repository under https://github.com/csc-training ?
```

Contributor guide

Open the contributing guide

Research direction

Review the Apps documentation and the proposed environment.yml, Dockerfiles, Singularity definition files, and csc-training repository context mentioned in the issue. Define which reproducibility details belong in each app entry and where shared environment files should live; done requires an agreed section structure and collection approach.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, github
Domain
devops, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.