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

3 4
A machine-readable metadata template for ESCAPE software.
Download and use the latest version of this template to upload your software in the ESCAPE repository.
vuillaut's avatar
vuillaut committed
5

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


vuillaut's avatar
vuillaut committed
10 11
## Mandatory

vuillaut's avatar
vuillaut committed
12
- title: project title
vuillaut's avatar
vuillaut committed
13
- authors: list of authors
vuillaut's avatar
vuillaut committed
14 15 16
- contact:
  - name: could be a person or an entity (e.g. ESCAPE or CTA Observatory)
  - email
vuillaut's avatar
vuillaut committed
17
- description: short description
vuillaut's avatar
vuillaut committed
18 19
- 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
20 21 22 23 24 25


## Optional

- Digital Object Identifier (doi)
- publication date (if already published elsewere, leave empty otherwise)
26
- type of publication: source, compiled, container
vuillaut's avatar
vuillaut committed
27 28 29 30 31 32 33 34 35 36 37 38 39 40
- grant/funding
- contributors
- references
- software requirements and dependencies
  - programming language
  - external dependencies (including matching versions)
  - operating system and compilation environement
- harware requirements
  - general use case (HPC, server, local desktop)
  - CPU, RAM, HDD/SSD requirements
  - GPU requirements


## Keywords
vuillaut's avatar
vuillaut committed
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
- CTA
- LSST
- LOFAR
- SKA
- EGO-Virgo
- KM3NeT
- ELT
- EST
- HL-LHC
- FAIR
- CERN
- ESO
- JIVE
- VO
- EOSC
- ESO
- Astronomy
- Astroparticle physics
- Particle physics