Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/singularity doc #11

Merged
merged 8 commits into from
Sep 6, 2022
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _episodes/08-gitlab-ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ keypoints:
## Introduction
In this section, we learn how to combine the forces of docker and gitlab CI to automatically keep your analysis environment up-to-date. This is accomplished by adding an extra stage to the CI pipeline for each analysis repo, which builds a container image that includes all aspects of the environment needed to run the code.

We will be doing this using the [CMS OpenData HTauTau Analysis Payload](https://hsf-training.github.io/hsf-training-cms-analysis-webpage/). Specifically, we will be using two "snapshots" of this code which are the repositories described on the [setup page](https://hsf-training.github.io/hsf-training-docker/setup.html) of this training. A walkthrough of how to setup those repositories can also be found [on this video](https://www.youtube.com/watch?v=krsBupoxoNI&list=PLKZ9c4ONm-VnqD5oN2_8tXO0Yb1H_s0sj&index=7). If you don't already have this setup, take a detour now and watch that video and revisit the setup page.
We will be doing this using the [CMS OpenData HTauTau Analysis Payload](https://hsf-training.github.io/hsf-training-cms-analysis-webpage/). Specifically, we will be using two "snapshots" of this code which are the repositories described on the [setup page](https://hsf-training.github.io/hsf-training-docker/setup.html) of this training. A walkthrough of how to setup those repositories can also be found [on this video](https://www.youtube.com/watch?v=krsBupoxoNI&list=PLKZ9c4ONm-VnqD5oN2_8tXO0Yb1H_s0sj&index=7). The "snapshot" repositories are available on GitHub ([skimmer repository](https://github.com/hsf-training/hsf-training-cms-analysis-snapshot) and [statistics repository](https://github.com/hsf-training/hsf-training-cms-analysis-snapshot-stats) ). If you don't already have this setup, take a detour now and watch that video and revisit the setup page.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

( I'll open a PR to wrap all long lines after everything else is merged. And if only to produce nicer diffs, because it took me some time to figure out that you're just adding something here ;) )

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good idea



### Writing your Dockerfile
Expand Down
5 changes: 4 additions & 1 deletion _episodes/10-singularity.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ On LXPLUS, the tool to run containers is Singularity.
**The following commands will therefore all be run on LXPLUS**
(`lxplus7.cern.ch` or later specifically).

This lesson will teach the basics of using Singularity to make containers of docker containers,
for more information please see the [Singularity Documentation](https://sylabs.io/guides/3.6/user-guide/singularity_and_docker.html)
bregnery marked this conversation as resolved.
Show resolved Hide resolved

## Running custom images with Singularity

Some of the LHC experiments have scripts for running singularity that hide the complexity.
Expand Down Expand Up @@ -99,7 +102,7 @@ export SINGULARITY_DOCKER_PASSWORD='mysecretpass'
> > ## Solution
> > ~~~bash
> > export SINGULARITY_CACHEDIR="/tmp/$(whoami)/singularity"
> > singularity shell -B /afs -B /eos -B /cvmfs docker://gitlab-registry.cern.ch/[repo owner's username]/[skimming repo name]:[branch name]-[shortened commit SHA] --docker-login
> > singularity shell -B /afs -B /eos -B /cvmfs --docker-login docker://gitlab-registry.cern.ch/[repo owner's username]/[skimming repo name]:[branch name]-[shortened commit SHA]
klieret marked this conversation as resolved.
Show resolved Hide resolved
> > ~~~
> > {: .source}
> {: .solution}
Expand Down
32 changes: 0 additions & 32 deletions _episodes/12-challenge-examples.md

This file was deleted.

8 changes: 8 additions & 0 deletions setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ title: Setup

To install Docker Community Edition on your Linux, Mac, or Windows machine follow the [instructions in the Docker docs](https://docs.docker.com/install/).

If you are using Linux, then please also follow these [post installation instructions](https://docs.docker.com/engine/install/linux-postinstall/).

To test your docker set up, run the following command:

~~~bash
docker run hello-world
~~~

Once you've got docker up and running, do the following docker image pulls in advance to save waiting during the tutorial:

~~~bash
Expand Down