https://github.com/vre-hub/science-projects
VRE example science projects
https://github.com/vre-hub/science-projects
dark-matter data-analysis docker extreme-universe jupyter-notebook
Last synced: 5 months ago
JSON representation
VRE example science projects
- Host: GitHub
- URL: https://github.com/vre-hub/science-projects
- Owner: vre-hub
- License: mit
- Created: 2023-03-02T14:35:02.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-07-30T07:51:43.000Z (11 months ago)
- Last Synced: 2025-07-30T09:42:31.226Z (11 months ago)
- Topics: dark-matter, data-analysis, docker, extreme-universe, jupyter-notebook
- Homepage:
- Size: 75.2 KB
- Stars: 1
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Authors: AUTHORS.md
Awesome Lists containing this project
README
# Reproducible CERN VRE analyses
The VRE aims at developing:
- an infrastructure where to run an end-to-end analysis in one place
- a solution to preserve the analysis steps in case of re-use
- an interdisciplinary open science example built from a bottom-up effort
## ESCAPE EOSC-Future science projects
[EOSC-Future](https://eoscfuture.eu/) funded two different kinds of science projects:
1. [Dark Matter](https://projectescape.eu/dark-matter-test-science-project)
2. [Extreme Universe](https://projectescape.eu/extreme-universe-and-gravitational-waves-science-project)
You can find out more about them [here](https://escape2020.pages.in2p3.fr/virtual-environment/home/) and on the [ESCAPE project page](https://projectescape.eu/escape-and-eosc-future).
## ESCAPE Open Collaboration and VRE related project
If you want to run your analysis in the VRE, use one of the folders within this repository, or create a new category. Then follow the instructions below:
1. Clone this repository with `git clone`
2. Add your project as a submodule of this repository
```bash
$ git submodule add /
# For example
$ git submodule add https://github.com/jared-little/atlas-dilepton dark_matter/ATLAS-dilepton
```
You can add the submodule to an existing directory (`dark_matter`, `extreme_universe`, `gravitational_waves`) or create a new category if necessary.
3. Create a Pull Request to add your new submodule
This repository contains the code and the analysis steps to reproduce the analyses that the scientists have decided to make public.
In order to re-run an analysis stored here, follow the following steps:
- if you didn't already, create a IAM account following [this](https://vre-hub.github.io/docs/rucio.html). It will authenticate you to the JupyterLab service, Rucio and Reana.
- log into the [VRE platform](https://jhub-vre.cern.ch/) by using your IAM credentials.
- then use Reana to execute your analysis. You have two ways of using Reana:
1. via the [VRE-Reana UI](https://reana-vre.cern.ch/):
- obtain a Reana token via UI interface.
- open a terminal on JupyterLab and add your reana server and reana secrets via the `reana-client` following [this](https://vre-hub.github.io/docs/reana.html).
- have a look how to create a reana file and how to run it by checking the `yaml` and the `bash` files of the, for example, [ATLAS Dark Matter reinterpretation](https://github.com/jared-little/atlas-dilepton/) science project.
- check the status of your workflow run on the Reana UI and get the outputted results.
2. using the [Reana JupyterLab extension](https://github.com/vre-hub/reana-jupyterlab-extension):
- allows using the same functionalities as reana, but from the [JupyterLab interface](https://jhub-vre.cern.ch/).
# License and citation
This repository is a compilation of different projects, each one with its own license. The same applies to its citation. Please check the license and citation of each project before using it.
This repository is licensed under the MIT license. Please be aware that the license of this repository does not apply to the linked repositories submodules.