Skip to content

vre-hub/science-projects

Repository files navigation

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 funded two different kinds of science projects:

  1. Dark Matter
  2. Extreme Universe

You can find out more about them here and on the ESCAPE project page.

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
$ git submodule add <url> <science_project>/<project_name>

# 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. It will authenticate you to the JupyterLab service, Rucio and Reana.
  • log into the VRE platform 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:
      • 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.
      • 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 science project.
      • check the status of your workflow run on the Reana UI and get the outputted results.
    2. using the Reana JupyterLab extension:

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.