README.md 1.45 KB
Newer Older
vuillaut's avatar
vuillaut committed
1
# ESCAPE metadata template
Vuillaume's avatar
Vuillaume committed
2

3
A machine-readable metadata template for ESCAPE software.
vuillaut's avatar
vuillaut committed
4

5
Download and use the latest version of this template to upload your software in the ESCAPE repository.
vuillaut's avatar
vuillaut committed
6

7
There are mandatory and optional fields.
vuillaut's avatar
vuillaut committed
8 9
Please find below the description of the fields.

vuillaut's avatar
vuillaut committed
10 11
Comments are welcome. Open an issue here or email the authors.

vuillaut's avatar
vuillaut committed
12

vuillaut's avatar
vuillaut committed
13 14
## Mandatory

vuillaut's avatar
vuillaut committed
15
- title: project title
vuillaut's avatar
vuillaut committed
16
- authors: list of authors
vuillaut's avatar
vuillaut committed
17 18 19
- contact:
  - name: could be a person or an entity (e.g. ESCAPE or CTA Observatory)
  - email
vuillaut's avatar
vuillaut committed
20
- description: short description
vuillaut's avatar
vuillaut committed
21 22
- keywords: list of keywords to categories the project. A pre-defined list of keywords is given below.
- license: the open-source project license (e.g. MIT)
vuillaut's avatar
vuillaut committed
23 24 25 26 27 28


## Optional

- Digital Object Identifier (doi)
- publication date (if already published elsewere, leave empty otherwise)
29
- type of publication: source, compiled, container
vuillaut's avatar
vuillaut committed
30 31 32
- grant/funding
- contributors
- references
vuillaut's avatar
vuillaut committed
33 34 35 36
- language: programming language
- dependencies: external dependencies (including matching versions)
- os: operating system
- compiler: compilation environement
Vuillaume's avatar
Vuillaume committed
37
- hardware requirements
vuillaut's avatar
vuillaut committed
38 39 40
  - general use case (HPC, server, local desktop)
  - CPU, RAM, HDD/SSD requirements
  - GPU requirements
vuillaut's avatar
vuillaut committed
41 42 43
- multi-threading: true or false
- container: dependency (including matching version)

vuillaut's avatar
vuillaut committed
44 45


vuillaut's avatar
vuillaut committed
46
## Keywords list
vuillaut's avatar
vuillaut committed
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
- CTA
- LSST
- LOFAR
- SKA
- EGO-Virgo
- KM3NeT
- ELT
- EST
- HL-LHC
- FAIR
- CERN
- ESO
- JIVE
- VO
- EOSC
- ESO
- Astronomy
- Astroparticle physics
- Particle physics