* 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**.
* A [**README** file](https://help.github.com/en/github/getting-started-with-github/create-a-repo#commit-your-first-change), similar to this one.
* 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**.
* A [**README** file](https://help.github.com/en/github/getting-started-with-github/create-a-repo#commit-your-first-change),
similar to this one.
* Contributing guidelines.
- See below the general guidelines for the ESCAPE repository.
* A [code of conduct](https://opensource.guide/code-of-conduct/).
...
...
@@ -22,7 +30,8 @@ It would be highly suitable to include too:
- A .gitignore file.
- Unitary and integration tests.
**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).
**Please feel free to copy / base on / template this project!** (Look to left of the `Clone or download` button in the
Take few minutes to check the [ESCAPE repository's guidelines](https://gitlab.in2p3.fr/escape2020/guidelines) too.
...
...
@@ -30,21 +39,33 @@ Take few minutes to check the [ESCAPE repository's guidelines](https://gitlab.in
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.
- You should ask developer access through the Gitlab interface and send an email to vuillaume [at] lapp.in2p3.fr with
your institution email.
- You will then be able to open a new project and transfer code.
- All the code provided should be uploaded from the [zenodo ESCAPE community](https://zenodo.org/communities/escape2020/).
- All the code provided should be uploaded from the [Zenodo ESCAPE community](https://zenodo.org/communities/escape2020/).
- 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).
- 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).
- 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.
- 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.
***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.
***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
### Singularity image container and CI/CD to Zenodo
Documentation of how to create a Docker image / container of your code and add it to the ESCAPE repository and community is under construction.
The documentation of how to create a Singularity image / container of your code, upload it to your repository, and also add
it to the ESCAPE community in the [Zenodo repository](https://zenodo.org/communities/escape2020) can be found in the
`.gitlabci`, `.zenodoci` directories and in the `.gitlab-ci.yml` file. Please read carefully all the README files.
For an easy example of how to create a Singularity receipt from scratch (and its corresponding container when executed),
please have a look to the `singularity_utils` directory.
# Installation
...
...
@@ -55,17 +76,22 @@ Documentation of how to create a Docker image / container of your code and add i
```
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)).
You can also check other more elaborated ways - generally for bigger repositories - here (e.g.,
