README.md 1.21 KB
Newer Older
Vuillaume's avatar
Vuillaume committed
1 2
# machine-readable-template

vuillaut's avatar
vuillaut committed
3 4
Simple repository to provide a machine-readable template for ESCAPE projects

vuillaut's avatar
vuillaut committed
5
There are mandatory and optional fields defined from this [working document](https://cloud.escape2020.de/index.php/s/RGNw7kKABKotBQE)
vuillaut's avatar
vuillaut committed
6 7 8 9

## Mandatory

- project title
vuillaut's avatar
vuillaut committed
10
- authors: list of authors
vuillaut's avatar
vuillaut committed
11 12 13
- contact:
  - name: could be a person or an entity (e.g. ESCAPE or CTA Observatory)
  - email
vuillaut's avatar
vuillaut committed
14 15 16
- description: short description
- keywords: to be selected in a defined list of keywords
- license: open source
vuillaut's avatar
vuillaut committed
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37


## Optional

- Digital Object Identifier (doi)
- publication date (if already published elsewere, leave empty otherwise)
- type of publication: source code, packages, containerized... (complete list TBD)
- 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
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
- CTA
- LSST
- LOFAR
- SKA
- EGO-Virgo
- KM3NeT
- ELT
- EST
- HL-LHC
- FAIR
- CERN
- ESO
- JIVE
- VO
- EOSC
- ESO
- Astronomy
- Astroparticle physics
- Particle physics