README.md 4.14 KB
Newer Older
Enrique Garcia's avatar
Enrique Garcia committed
1
# template_project_escape [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3572655.svg)](https://doi.org/10.5281/zenodo.3572655) [![Build Status](https://travis-ci.com/garciagenrique/template_project_escape.svg?branch=master)](https://travis-ci.com/garciagenrique/template_project_escape)
Enrique Garcia's avatar
Enrique Garcia committed
2 3


Enrique Garcia's avatar
Enrique Garcia committed
4 5 6 7
<p align="center">
   <img src="https://cdn.eso.org/images/large/ann18084a.jpg" width="640" height="453"/>
</p>

Enrique Garcia's avatar
Enrique Garcia committed
8
A simple template project to provide software to ESCAPE.
9

Enrique Garcia's avatar
Enrique Garcia committed
10
It shows the **basic documentation** a project should include, following the [opensource guide](https://opensource.guide/starting-a-project/):
11

Enrique Garcia's avatar
Enrique Garcia committed
12
* An [open source](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/licensing-a-repository#where-does-the-license-live-on-my-repository) **license**.
Enrique Garcia's avatar
Enrique Garcia committed
13
* A [**README** file](https://help.github.com/en/github/getting-started-with-github/create-a-repo#commit-your-first-change), similar to this one. 
14 15 16 17
* Contributing guidelines. 
    - See below the general guidelines for the ESCAPE repository.
* A [code of conduct](https://opensource.guide/code-of-conduct/).
    - Check why is a good idea to add one.
18
* The structure of the repository.
19

Enrique Garcia's avatar
style2  
Enrique Garcia committed
20
It would be highly suitable to include too:
21
   - A setup file as well as the basic commands to install the library (see below).
Enrique Garcia's avatar
Enrique Garcia committed
22
   - A .gitignore file.
Enrique Garcia's avatar
Enrique Garcia committed
23
   - Unitary and integration tests.
Enrique Garcia's avatar
Enrique Garcia committed
24
   
Enrique Garcia's avatar
Enrique Garcia committed
25
**Please feel free to copy / base on / template this project!** (Look to left of the `Clone or download` button in the [GitHub](https://github.com/garciagenrique/template_project_escape) site).
26

Enrique Garcia's avatar
Enrique Garcia committed
27
Take few minutes to check the [ESCAPE repository's guidelines](https://gitlab.in2p3.fr/escape2020/guidelines) too.
28

29
# Contributing guidelines for the ESCAPE repository
30

Enrique Garcia's avatar
Enrique Garcia committed
31 32 33
If you wish to provide software to the ESCAPE repository: 

 - You should ask developer access through the Gitlab interface and send an email to vuillaume [at] lapp.in2p3.fr with your institution email.
34

Enrique Garcia's avatar
Enrique Garcia committed
35
 - You will then be able to open a new project and transfer code.
Enrique Garcia's avatar
Enrique Garcia committed
36

Enrique Garcia's avatar
Enrique Garcia committed
37
 - All the code provided should be uploaded from the [zenodo ESCAPE community](https://zenodo.org/communities/escape2020/). 
Enrique Garcia's avatar
Enrique Garcia committed
38

Enrique Garcia's avatar
Enrique Garcia committed
39
 - For a detailed explanation of how to submit a contribution to a project / repository (Fork, create a branch, make a pull request...), please check the [opensource guide](https://opensource.guide/how-to-contribute/#how-to-submit-a-contribution) and/or the [git's documentation](https://git-scm.com/doc).
Enrique Garcia's avatar
Enrique Garcia committed
40

Enrique Garcia's avatar
Enrique Garcia committed
41
 - Once you are granted with developer access, you will be able to add a new blank project / import it (from other common repository managers, i.e., GitHub, GitLab, Bitbucket, Fogbugz...) to the [GitLab/ESCAPE](https://gitlab.in2p3.fr/escape2020) main page.
Enrique Garcia's avatar
Enrique Garcia committed
42

Enrique Garcia's avatar
Enrique Garcia committed
43 44 45 46 47
***PLEASE NOTE*** that if you have login GitLab by using the `[Shibbolenth]` service (eduGAIN, Fédération d'Identités RENATER), you will need to [add a SSH key](https://gitlab.in2p3.fr/help/ssh/README#generating-a-new-ssh-key-pair) to your GitLab profile if you want to 'push' your changes to the server. 

### Docker / containers

Documentation of how to create a Docker image / container of your code and add it to the ESCAPE repository and community is under construction. 
Enrique Garcia's avatar
Enrique Garcia committed
48

49 50 51 52 53 54 55 56 57 58 59
# Installation

```sh
  $ git clone https://gitlab.in2p3.fr/escape2020/escape/template_project_escape.git
  $ cd template_project_escape
  $ python setup.py install
``` 

This is an easy method to install the library. 
You can also check other more elaborated ways - generally for bigger repositories - here (e.g., [cta-observatory/cta-lstchain](https://github.com/cta-observatory/cta-lstchain), [cta-observatory/ctapipe](https://github.com/cta-observatory/ctapipe)).

Enrique Garcia's avatar
Enrique Garcia committed
60
# Citing 
Enrique Garcia's avatar
Enrique Garcia committed
61 62 63 64 65
In case of citing this repository, use the following DOI:
 - v 1.0: [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3572655.svg)](https://doi.org/10.5281/zenodo.3572655)

Do not forget to include the code in the [zenodo ESCAPE community](https://zenodo.org/communities/escape2020/). 
 - ***Note that*** you will be able to assign a DOI in the moment you include your code/repository to zenodo. 
66

Enrique Garcia's avatar
Enrique Garcia committed
67
# Report an issue / Ask a question
Enrique Garcia's avatar
Enrique Garcia committed
68 69 70 71
Use [GitLab Issues](https://gitlab.in2p3.fr/groups/escape2020/-/issues).

# Contact
Email to vuillaume [at] lapp.in2p3.fr / garcia [at] lapp.in2p3.fr.